From 6e2f5a1138d146022477637c6d2df959a534974a Mon Sep 17 00:00:00 2001 From: maike Date: Sun, 6 Sep 2020 01:48:58 +0200 Subject: [PATCH] [doc] How to set up the frontend dev environment --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 32719bf..1ff8389 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,8 @@ ## Setup Development Environment +### Backend + 1. Install `python>=3.7` 2. Create a virtual environment with `python3 -m venv .venv` 3. Activate your dev environment with `source .venv/bin/activate` @@ -12,6 +14,18 @@ 7. Add git-hook to check commmit message format with `ln -s ../../git-hooks/commit-msg .git/hooks/commit-msg` +### Frontend + +1. Install node.js (e.g. via + [nvm](https://github.com/nvm-sh/nvm#installation-and-update)) +2. `cd kibicara-frontend` +3. Install the dependencies with `npm i` +4. Install Angular with `npm i -g @angular/cli` +5. Turn off production mode with `sudo su -c 'echo "production = 0" >> /etc/kibicara.conf'` +6. Start the backend in a different terminal +7. To serve and open the application, run ng s -o. The application will open + under [http://127.0.0.1:4200](http://127.0.0.1:4200). + ### Build and Test Cycle - Install with `pip install .`