[misc] Move things to the right place
This commit is contained in:
parent
aed5710da7
commit
fb543cffb9
|
@ -3,19 +3,18 @@
|
||||||
|
|
||||||
## Setup Development Environment
|
## Setup Development Environment
|
||||||
|
|
||||||
|
### General
|
||||||
|
|
||||||
|
1. Install `python>=3.10` and development packages
|
||||||
|
(`apt install python3-dev g++` on Ubuntu)
|
||||||
|
2. Run `./setup.sh`
|
||||||
|
|
||||||
### Backend
|
### Backend
|
||||||
|
|
||||||
1. Install `python>=3.8 python3-dev g++`
|
0. `cd backend`
|
||||||
2. Create a virtual environment with `python3 -m venv .venv`
|
1. Activate your dev environment with `source .venv/bin/activate`
|
||||||
3. Activate your dev environment with `source .venv/bin/activate`
|
2. Install with `pip install .`
|
||||||
4. Update pip packages with `pip install -U pip setuptools wheel`
|
3. Turn off production mode: `sudo su -c 'echo "production = 0" >> /etc/kibicara.conf'`
|
||||||
5. Install with `pip install .`
|
|
||||||
6. Install development dependencies with `pip install tox black pytest pytest-aiohttp`
|
|
||||||
7. Add git-hook to run test and stylecheck before commmit with
|
|
||||||
`ln -s ../../git-hooks/pre-commit .git/hooks/pre-commit`
|
|
||||||
8. Add git-hook to check commmit message format with
|
|
||||||
`ln -s ../../git-hooks/commit-msg .git/hooks/commit-msg`
|
|
||||||
9. Turn off production mode: `sudo su -c 'echo "production = 0" >> /etc/kibicara.conf'`
|
|
||||||
|
|
||||||
#### Cheatsheet
|
#### Cheatsheet
|
||||||
|
|
||||||
|
@ -23,7 +22,7 @@
|
||||||
- Execute Kibicara with `kibicara` (verbose: `kibicara -vvv`)
|
- Execute Kibicara with `kibicara` (verbose: `kibicara -vvv`)
|
||||||
- Interact with Swagger REST-API Documentation: `http://localhost:8000/api/docs`
|
- Interact with Swagger REST-API Documentation: `http://localhost:8000/api/docs`
|
||||||
- Test and stylecheck with `tox`
|
- Test and stylecheck with `tox`
|
||||||
- Fix style issues with `black -S kibicara tests`
|
- Fix style issues with `black -S src tests`
|
||||||
|
|
||||||
### Frontend
|
### Frontend
|
||||||
|
|
||||||
|
|
Before Width: | Height: | Size: 2.6 KiB After Width: | Height: | Size: 2.6 KiB |
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue