mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-26 02:11:53 +00:00
db0695126f
* store, properties, manifest * interfaces * init and backups * fix init and backups * file models * more versions * dependencies * config except dynamic types * clean up config * remove disabled from non-dynamic vaues * actions * standardize example code block formats * wip: actions refactor Co-authored-by: Jade <Blu-J@users.noreply.github.com> * commit types * fix types * update types * update action request type * update apis * add description to actionrequest * clean up imports * revert package json * chore: Remove the recursive to the index * chore: Remove the other thing I was testing * flatten action requests * update container runtime with new config paradigm * new actions strategy * seems to be working * misc backend fixes * fix fe bugs * only show breakages if breakages * only show success modal if result * don't panic on failed removal * hide config from actions page * polyfill autoconfig * use metadata strategy for actions instead of prev * misc fixes * chore: split the sdk into 2 libs (#2736) * follow sideload progress (#2718) * follow sideload progress * small bugfix * shareReplay with no refcount false * don't wrap sideload progress in RPCResult * dont present toast --------- Co-authored-by: Aiden McClelland <me@drbonez.dev> * chore: Add the initial of the creation of the two sdk * chore: Add in the baseDist * chore: Add in the baseDist * chore: Get the web and the runtime-container running * chore: Remove the empty file * chore: Fix it so the container-runtime works --------- Co-authored-by: Matt Hill <MattDHill@users.noreply.github.com> Co-authored-by: Aiden McClelland <me@drbonez.dev> * misc fixes * update todos * minor clean up * fix link script * update node version in CI test * fix node version syntax in ci build * wip: fixing callbacks * fix sdk makefile dependencies * add support for const outside of main * update apis * don't panic! * Chore: Capture weird case on rpc, and log that * fix procedure id issue * pass input value for dep auto config * handle disabled and warning for actions * chore: Fix for link not having node_modules * sdk fixes * fix build * fix build * fix build --------- Co-authored-by: Matt Hill <mattnine@protonmail.com> Co-authored-by: Jade <Blu-J@users.noreply.github.com> Co-authored-by: J H <dragondef@gmail.com> Co-authored-by: Jade <2364004+Blu-J@users.noreply.github.com> Co-authored-by: Matt Hill <MattDHill@users.noreply.github.com>
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
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, andlocalhost. - Use "maskAsHttps" to mock the protocol over which the web UI is served.
truemeans https;falsemeans 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