mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-26 02:11:53 +00:00
0469aab433
* wip * update marketplace categories styling * update logo icons * add sort pipe * update search component styling * clean up categories component * cleanup and remove unnecessary sort pipe * query packages in selected category * fix search styling * add reg icon and font, adjust category styles * fix build from rebasing integration/refactors * adjust marketplace types for icon with store data, plus formatting * formatting * update categories and search * hover styling for categories * category styling * refactor for category as a behavior subject * more category styling * base functionality with new marketplace components * styling cleanup * misc style fixes and fix category selection from package page * fixes from review feedback * add and style additional details * implement release notes modal * fix menu when on service show page mobile to display change marketplace * style and responsiveness fixes * rename header to sidebar * input icon config to sidebar * add mime type pipe and type fn * review feedback fixes * skeleton text, more abstraction * reorder categories, clean up a little * audit sidebar, categories, store-icon, marketplace-sidebar, search * finish code cleanup and fix few bugs * misc fixes and cleanup * fix broken styles and markdown * bump shared marketplace version * more cleanup * sync package lock * rename sidebar component to menu * wip preview sidebar * sync package lock * breakout package show elements into components * link to brochure in preview; custom taiga button styles * move marketplace preview component into ui; open preview when viewing service in marketplace * sync changes post file struture rename * further cleanup * create service for sidebar toggle and cleanup marketplace components * bump shared marketplace version * bump shared for new images needed for brochure marketplace * cleanup --------- Co-authored-by: Matt Hill <mattnine@protonmail.com>
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
Check that your versions match the ones below
node --version
v18.15.0
npm --version
v8.0.0
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
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