mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-30 20:14:49 +00:00
refine readme
This commit is contained in:
committed by
Aiden McClelland
parent
33fe3e1059
commit
e77c0a46db
37
ui/README.md
37
ui/README.md
@@ -1,29 +1,31 @@
|
|||||||
# Embassy UI
|
# Embassy UI
|
||||||
|
|
||||||
## Setup Instructions
|
## Development Environment Setup
|
||||||
|
|
||||||
**Make sure you have git, node, npm, and rust installed**
|
**Make sure you have git, node, npm, and rust installed**
|
||||||
|
|
||||||
`npm i -g @ionic/cli`
|
### Building The Mock Development Server
|
||||||
|
|
||||||
`git clone https://github.com/Start9Labs/ws-example.git`
|
`git clone https://github.com/Start9Labs/ws-example.git`
|
||||||
|
|
||||||
|
`cd ws-example`
|
||||||
|
|
||||||
|
**Start the server**
|
||||||
|
|
||||||
|
`cargo run -- -vvv -c example-config.toml`
|
||||||
|
|
||||||
|
### Building Embassy UI
|
||||||
|
|
||||||
|
**In a new terminal window:**
|
||||||
|
|
||||||
|
`npm i -g @ionic/cli`
|
||||||
|
|
||||||
`git clone https://github.com/Start9Labs/embassy-os.git`
|
`git clone https://github.com/Start9Labs/embassy-os.git`
|
||||||
|
|
||||||
`cd embassy-os`
|
`cd embassy-os`
|
||||||
|
|
||||||
`git submodule update --init --recursive`
|
`git submodule update --init --recursive`
|
||||||
|
|
||||||
Then open `ws-example`, and `embassy-os`, in separate tabs.
|
|
||||||
|
|
||||||
### ws-example
|
|
||||||
|
|
||||||
**Start the server**
|
|
||||||
|
|
||||||
`cargo run -- -vvv -c example-config.toml`
|
|
||||||
|
|
||||||
### embassy-os
|
|
||||||
|
|
||||||
`cd ui/`
|
`cd ui/`
|
||||||
|
|
||||||
`npm run build-deps`
|
`npm run build-deps`
|
||||||
@@ -43,6 +45,7 @@ In `config.json`, edit the "mocks" section to look like the following:
|
|||||||
"skipStartupAlerts": true
|
"skipStartupAlerts": true
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Valid values for "connection" are `ws` and `poll`.
|
Valid values for "connection" are `ws` and `poll`.
|
||||||
|
|
||||||
Valid values for "maskAs" are `tor` and `lan`.
|
Valid values for "maskAs" are `tor` and `lan`.
|
||||||
@@ -52,3 +55,13 @@ You can also enable or disable startup alerts.
|
|||||||
**Start the client**
|
**Start the client**
|
||||||
|
|
||||||
`ionic serve`
|
`ionic serve`
|
||||||
|
|
||||||
|
### Updating Server Mocks
|
||||||
|
|
||||||
|
If you want to update mock data inside ws-example, you must do the following:
|
||||||
|
|
||||||
|
1. Stop the ws-example server
|
||||||
|
1. Run `rm embassy.db`
|
||||||
|
1. Delete `patch-db-cache` from your browser's Local Storage
|
||||||
|
1. Restart ws-example
|
||||||
|
1. Refresh the browser window
|
||||||
Reference in New Issue
Block a user