[doc] How to set up the frontend dev environment

This commit is contained in:
maike 2020-09-06 01:48:58 +02:00 committed by Maike
parent 7633ab9a50
commit 6e2f5a1138

View file

@ -2,6 +2,8 @@
## Setup Development Environment ## Setup Development Environment
### Backend
1. Install `python>=3.7` 1. Install `python>=3.7`
2. Create a virtual environment with `python3 -m venv .venv` 2. Create a virtual environment with `python3 -m venv .venv`
3. Activate your dev environment with `source .venv/bin/activate` 3. Activate your dev environment with `source .venv/bin/activate`
@ -12,6 +14,18 @@
7. Add git-hook to check commmit message format with 7. Add git-hook to check commmit message format with
`ln -s ../../git-hooks/commit-msg .git/hooks/commit-msg` `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 ### Build and Test Cycle
- Install with `pip install .` - Install with `pip install .`