From bde6169746c65aec69ae8634c54eb83e97ea5439 Mon Sep 17 00:00:00 2001
From: Benjamin B <7598058+BBlackwo@users.noreply.github.com>
Date: Sat, 4 Jun 2022 04:26:45 +1000
Subject: [PATCH] Update contribution and frontend readme (#1467)

* docs: small updates to contributing and frontend readme

* chore: change build:deps script to use npm ci
---
 CONTRIBUTING.md       |  6 +++---
 frontend/README.md    | 15 ++++++++-------
 frontend/package.json |  2 +-
 3 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f72e3da5a..428688fac 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -21,7 +21,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
   - [Suggesting Enhancements](#suggesting-enhancements)
   - [Project Structure](#project-structure)
   - [Your First Code Contribution](#your-first-code-contribution)
-    - [Setting up your development environment](#setting-up-your-development-environment)
+    - [Setting Up Your Development Environment](#setting-up-your-development-environment)
     - [Building The Image](#building-the-image)
   - [Improving The Documentation](#improving-the-documentation)
 - [Styleguides](#styleguides)
@@ -148,11 +148,11 @@ EmbassyOS is composed of the following components. Please visit the README for e
 
 ### Your First Code Contribution
 
-#### Setting up your development environment
+#### Setting Up Your Development Environment
 
 First, clone the EmbassyOS repository and from the project root, pull in the submodules for dependent libraries.
 
-```
+```sh
 git clone https://github.com/Start9Labs/embassy-os.git
 git submodule update --init --recursive
 ```
diff --git a/frontend/README.md b/frontend/README.md
index ec99ff7c2..fcee5d680 100644
--- a/frontend/README.md
+++ b/frontend/README.md
@@ -5,7 +5,8 @@ EmbassyOS has three user interfaces and a shared library, all written in Ionic/A
 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.
+1. **marketplace**: abstracted ui elements to search for, list and display details for packages and their dependencies
+1. **shared**: contains components, types, and functions shared amongst all of the UIs.
 
 ## Development Environment Setup
 
@@ -15,7 +16,7 @@ EmbassyOS has three user interfaces and a shared library, all written in Ionic/A
 
 Check your versions
 
-```
+```sh
 node --version
 v16.10.0
 
@@ -27,7 +28,7 @@ v8.0.0
 
 1. Clone the repository
 
-```
+```sh
 git clone https://github.com/Start9Labs/embassy-os.git
 cd embassy-os
 git submodule update --init --recursive
@@ -38,7 +39,7 @@ npm run build:deps
 
 2. Copy `config-sample.json` and its contents to a new file `config.json`.
 
-```
+```sh
 cp config-sample.json config.json
 ```
 
@@ -47,7 +48,7 @@ Valid values for "maskAs" are `tor` and `lan`.
 
 3. Start the development server(s)
 
-```
+```sh
 npm run start:ui
 npm run start:setup-wizard
 npm run start:diagnostic-ui
@@ -61,7 +62,7 @@ This section enables you to run a local frontend with a remote backend (eg. host
 
 2. Create a proxy configuration file from the sample:
 
-```
+```sh
 cp proxy.conf.json.sample proxy.conf.json
 ```
 
@@ -69,6 +70,6 @@ cp proxy.conf.json.sample proxy.conf.json
 
 4. Start the development server
 
-```
+```sh
 npm run start:ui:proxy
 ```
diff --git a/frontend/package.json b/frontend/package.json
index 027692568..23ebf90b8 100644
--- a/frontend/package.json
+++ b/frontend/package.json
@@ -10,7 +10,7 @@
     "check:diagnostic-ui": "tsc --project projects/diagnostic-ui/tsconfig.json --noEmit --skipLibCheck",
     "check:setup-wizard": "tsc --project projects/setup-wizard/tsconfig.json --noEmit --skipLibCheck",
     "check:ui": "tsc --project projects/ui/tsconfig.json --noEmit --skipLibCheck",
-    "build:deps": "rm -rf .angular/cache && cd ../patch-db/client && npm install && npm run build",
+    "build:deps": "rm -rf .angular/cache && cd ../patch-db/client && npm ci && npm run build",
     "build:diagnostic-ui": "ng run diagnostic-ui:build",
     "build:setup-wizard": "ng run setup-wizard:build",
     "build:ui": "ng run ui:build && tsc projects/ui/postprocess.ts && node projects/ui/postprocess.js && git log | head -n1 > dist/ui/git-hash.txt",