mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-31 04:23:40 +00:00
feat: move all frontend projects under the same Angular workspace (#1141)
* feat: move all frontend projects under the same Angular workspace * Refactor/angular workspace (#1154) * update frontend build steps Co-authored-by: waterplea <alexander@inkin.ru> Co-authored-by: Matt Hill <matthewonthemoon@gmail.com> Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
This commit is contained in:
52
frontend/README.md
Normal file
52
frontend/README.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# EmbassyOS Frontend
|
||||
|
||||
EmbassyOS has three user interfaces and a shared library, all written in Ionic/Angular/Typescript using an Angular workspace environment:
|
||||
|
||||
1. **ui**: the main user interface
|
||||
1. **setup-wizard**: used to facilitate initial setup
|
||||
1. **diagnostic-ui**: used to display certain diagnostic information in the event EmbassyOS fails to initialize
|
||||
1. **shared**: contains components, types, and functions shared amongst the three UIs.
|
||||
|
||||
## Development Environment Setup
|
||||
|
||||
- Requirements:
|
||||
- [Install nodejs](https://nodejs.org/en/)
|
||||
- [Install npm](https://www.npmjs.com/get-npm)
|
||||
|
||||
Check your versions
|
||||
|
||||
```
|
||||
node --version
|
||||
v16.10.0
|
||||
|
||||
npm --version
|
||||
v8.0.0
|
||||
```
|
||||
|
||||
## Running locally with mocks
|
||||
|
||||
```
|
||||
git clone https://github.com/Start9Labs/embassy-os.git
|
||||
cd embassy-os
|
||||
git submodule update --init --recursive
|
||||
cd frontend
|
||||
npm ci
|
||||
npm run build:deps
|
||||
```
|
||||
|
||||
Copy `config-sample.json` and its contents to a new file `config.json`.
|
||||
|
||||
```
|
||||
cp config-sample.json config.json
|
||||
```
|
||||
|
||||
By default, "useMocks" is set to `true`.
|
||||
Valid values for "maskAs" are `tor` and `lan`.
|
||||
|
||||
**Start the development server(s)**
|
||||
|
||||
```
|
||||
npm run start:ui
|
||||
npm run start:setup-wizard
|
||||
npm run start:diagnostic-ui
|
||||
```
|
||||
Reference in New Issue
Block a user