start-os/web

StartOS Web

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

StartOS conditionally serves one of three 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

• Install nodejs
• Install 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 ci
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
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