mirror of https://github.com/Start9Labs/start-os.git synced 2026-03-26 02:11:53 +00:00

Files

Matt Hill 8a559b71fd 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>

2022-01-24 15:24:02 -07:00

1.3 KiB

Raw Blame History

Embassy Diagnostic UI

Development Environment Setup

Requirements
- Install nodejs
- Install npm
- Install ionic cli
- Recommended: Install nvm

node --version
v16.11.0

npm --version
v8.0.0

Styleguide

This project utilizes tslint for formatting.

Building Diagnostic UI

git clone https://github.com/Start9Labs/embassy-os.git

cd embassy-os

git submodule update --init --recursive - installs submodule projects

cd diagnostic-ui/ - installs node package dependencies

npm install -g @ionic/cli

npm --prefix . install

Copy config-sample.json and contents to a new file config.json

Start the development server

Serves the diagnostic-ui on localhost:8100 for local development. Edit ./diagnostic-ui/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 diagnostic-ui/www.

npm --prefix ui run build-prod

1.3 KiB Raw Blame History