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
@@ -11,8 +15,11 @@ v16.11.0
npm --version
v8.0.0
```
## Styleguide
### Building Embassy UI
This project utilizes [tslint](https://palantir.github.io/tslint/) for formatting.
## Building Setup Wizard
`git clone https://github.com/Start9Labs/embassy-os.git`
@@ -24,8 +31,21 @@ v8.0.0
`npm --prefix . install`
Copy `config-sample.json` and contents to new file `config.json`
Copy `config-sample.json` and contents to a new file called `config.json`
**Start the development server**
### Start the development server
`ionic serve`
Serves the ui on localhost:8100 for local development.
Edit `./setup-wizard/config.json` and set `useMocks: 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 `setup-wizard/www`.
```
npm --prefix ui run build-prod
```