rename frontend to web

web/README.md

@@ -0,0 +1,75 @@
+# StartOS Frontend
+
+StartOS has three user interfaces and a shared library, all written in Ionic/Angular/Typescript using an Angular workspace environment:
+
+1. **ui**: the main user interface
+1. **install-wizard**: used to install StartOS
+1. **setup-wizard**: used to facilitate initial setup
+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
+
+- Requirements:
+  - [Install nodejs](https://nodejs.org/en/)
+  - [Install npm](https://www.npmjs.com/get-npm)
+
+Check your versions
+
+```sh
+node --version
+v18.15.0
+
+npm --version
+v8.0.0
+```
+
+## Running locally with mocks
+
+1. Clone the repository
+
+```sh
+git clone https://github.com/Start9Labs/start-os.git
+cd start-os
+git submodule update --init --recursive
+cd frontend
+npm ci
+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
+```
+
+By default, "useMocks" is set to `true`.
+Valid values for "maskAs" are `tor` and `lan`.
+
+3. Start the development server(s)
+
+```sh
+npm run start:ui
+npm run start:install
+npm run start:setup
+```
+
+## Running locally with proxied backend
+
+This section enables you to run a local frontend with a remote backend (eg. hosted on a live Start9 server). It assumes you have completed Step 1 and Step 2 in the [section above](#running-locally-with-mocks)
+
+1. Set `useMocks: false` in `config.json`
+
+2. Create a proxy configuration file from the sample:
+
+```sh
+cp proxy.conf-sample.json proxy.conf.json
+```
+
+3. Change the target address to desired IP address in `proxy.conf.json`
+
+4. Start the development server
+
+```sh
+npm run start:ui:proxy
+```