Merge branch 'Docs/Setup' into 'dev'

Docs: Add Commands

See merge request !190

README.md

@@ -21,30 +21,38 @@ Currently available routes in Coscine (Vue Router):
 
 (For a specific branch, build such a URL: `https://gitpod.io/#https://git.rwth-aachen.de/coscine/frontend/apps/ui/tree/{branch}`)
 
-## Starting the App 
-So, since we want to have it running on the root url at some point
-- Change the following Consul key's value key:
+## Commands
+
+This project uses [Yarn](https://yarnpkg.com/) and [Node.js](https://nodejs.org/en/) to manage its dependencies.
+
+### Project setup
+
+```
+yarn install
 ```
-    traefik/backends/sharepoint/servers/sharepoint/url
+
+### Compiles and hot-reloads for development
+```
+yarn dev
 ```
-    value (replace `XX` with your machine's name):  
+
+### Compiles and minifies for production
 ```
-    http://d-spXX.devlef.campus.rwth-aachen.de:9234
+yarn build
 ```
-    - This will disable your current Coscine instance, so to activate it back, remove the `:<PORT>` from the value.
 
-1. Run integrator script on branch `uiv2`
-2. Add required frontend libraries to your workspace if necessary (e.g. here `api-client` and `form-generator`):
-    ```json
-    "workspaces": [
-      "apps/ui",
-      "libraries/form-generator",
-      "libraries/api-client"
-    ]
+### Runs the minified production build
+```
+yarn preview
 ```
-3. For each library checkout the relevant branch and execute `yarn install`, then `yarn build`
-  - Here: `api-client` on branch `dev`/`master`, then `yarn install` and `yarn build`
-  - Here: `form-generator` on branch `dev`/`master`, then `yarn install` and `yarn build`
-5. Check out the UI project on the provided repository branch. Start the app locally and execute `yarn install`, then `yarn dev`
-6. Change your Consul key according to the [Readme](https://git.rwth-aachen.de/coscine/frontend/apps/ui/-/blob/main/README.md) (see above)
-7. App is now running on your root (/) domain name, and not under `.../coscine/apps/ui/....` (e.g. https://d-sp16.devlef.campus.rwth-aachen.de/)
+
+### Lints files
+```
+yarn lint
+```
+
+### Lints and fixes files
+```
+yarn lint:fix
+```
+