mirror of https://github.com/Start9Labs/start-os.git synced 2026-03-26 10:21:52 +00:00

Files

Matt Hill 2ba56b8c59 Convert properties to an action (#2751 )

* update actions response types and partially implement in UI

* further remove diagnostic ui

* convert action response nested to array

* prepare action res modal for Alex

* ad dproperties action for Bitcoin

* feat: add action success dialog (#2753)

* feat: add action success dialog

* mocks for string action res and hide properties from actions page

---------

Co-authored-by: Matt Hill <mattnine@protonmail.com>

* return null

* remove properties from backend

* misc fixes

* make severity separate argument

* rename ActionRequest to ActionRequestOptions

* add clearRequests

* fix s9pk build

* remove config and properties, introduce action requests

* better ux, better moocks, include icons

* fix dependency types

* add variant for versionCompat

* fix dep icon display and patch operation display

* misc fixes

* misc fixes

* alpha 12

* honor provided input to set values in action

* fix: show full descriptions of action success items (#2758)

* fix type

* fix: fix build:deps command on Windows (#2752)

* fix: fix build:deps command on Windows

* fix: add escaped quotes

---------

Co-authored-by: Aiden McClelland <me@drbonez.dev>

* misc db compatibility fixes

---------

Co-authored-by: Alex Inkin <alexander@inkin.ru>
Co-authored-by: Aiden McClelland <me@drbonez.dev>
Co-authored-by: Aiden McClelland <3732071+dr-bonez@users.noreply.github.com>

2024-10-17 13:31:56 -06:00

2.7 KiB

Raw Blame History

StartOS Web

StartOS web UIs are written in Angular/Typescript and leverage the Ionic Framework component library.

StartOS conditionally serves one of four Web UIs, depending on the state of the system and user choice.

install-wizard - UI for installing StartOS, served on localhost.
setup-wizard - UI for setting up StartOS, served on start.local.
ui - primary UI for administering StartOS, served on various hosts unique to the instance.

Additionally, there are two libraries for shared code:

marketplace - library code shared between the StartOS UI and Start9's brochure marketplace.
shared - library code shared between the various web UIs and marketplace lib.

Environment Setup

Install NodeJS and NPM

Check that your versions match the ones below

node --version
v20.17.0

npm --version
v10.8.2

Install and enable the Prettier extension for your text editor

Clone StartOS and load the PatchDB submodule if you have not already

git clone https://github.com/Start9Labs/start-os.git
cd start-os
git submodule update --init --recursive

Move to web directory and install dependencies

cd web
npm i
npm run build:deps

Note if you are on Windows you need to install make for these scripts to work. Easiest way to do so is to install Chocolatey and then run choco install make.

Copy `config-sample.json` to a new file `config.json`.

cp config-sample.json config.json

By default, "useMocks" is set to true.
Use "maskAs" to mock the host from which the web UI is served. Valid values are tor, local, and localhost.
Use "maskAsHttps" to mock the protocol over which the web UI is served. true means https; false means http.

Running the development server

You can develop using mocks (recommended to start) or against a live server. Either way, any code changes will live reload the development server and refresh the browser page.

Using mocks

Start the standard development server

npm run start:install-wiz
npm run start:setup
npm run start:ui

Proxying to a live server

In `config.json`, set "useMocks" to `false`

Copy `proxy.conf-sample.json` to a new file `proxy.conf.json`

cp proxy.conf-sample.json proxy.conf.json

Replace every instance of "<CHANGEME>" with the hostname of your remote server

Start the proxy development server

npm run start:ui:proxy

2.7 KiB Raw Blame History