Clean up README (#1114)

* Update README.md

* updated readme assets

* delete deprecated lifeline

* update contributing guide and delete old build guides/notes

* fix typos

* update ui formatting recommendation

* update readmes and contributing guide with build steps and dependencies

* add script to install sdk

Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
This commit is contained in:
Matt Hill
2022-01-24 15:24:02 -07:00
committed by GitHub
parent 24656d4824
commit 8a559b71fd
24 changed files with 144 additions and 665 deletions

View File

@@ -2,7 +2,11 @@
## Development Environment Setup
**Make sure you have git, nvm (node, npm), and rust installed**
- Requirements:
- [Install nodejs](https://nodejs.org/en/)
- [Install npm](https://www.npmjs.com/get-npm)
- [Install ionic cli](https://ionicframework.com/docs/intro/cli)
- Recommended: [Install nvm](https://github.com/nvm-sh/nvm)
```
node --version
@@ -12,23 +16,27 @@ npm --version
v8.0.0
```
### Building Embassy UI
## Styleguide
This project utilizes [prettier](https://prettier.io/) for formatting.
## Building Embassy UI
`git clone https://github.com/Start9Labs/embassy-os.git`
`cd embassy-os`
`git submodule update --init --recursive`
`git submodule update --init --recursive` - installs submodule projects
`cd ui/`
`npm install -g @ionic/cli`
`npm install -g @ionic/cli`
`npm --prefix . install`
`npm --prefix . install` - installs node package dependencies
`npm --prefix . run build-deps`
`npm --prefix . run build-deps` - compiles dependent libraries, particularly the client for patch-db
Copy `config-sample.json` to new file `config.json`
Copy `config-sample.json` and contents to a new file called `config.json`
In `config.json`, edit the "mocks" section to look like the following:
```
@@ -41,6 +49,18 @@ In `config.json`, edit the "mocks" section to look like the following:
Valid values for "maskAs" are `tor` and `lan`.
**Start the development server**
### Start the development server
`ionic serve`
Serves the ui on localhost:8100 for local development.
Edit `./ui/use-mocks.json` to 'true' to use mocks during local development
```
ionic serve
```
### Production Build
Before publishing a PR, please build for production and correct any errors. Run the following command, which compiles project customized for deployment to an Embassy, depositing build artifacts into `ui/www`.
```
npm --prefix ui run build-prod
```