[misc] Move things to the right place
This commit is contained in:
parent
aed5710da7
commit
fb543cffb9
CONTRIBUTING.md
backend
setup.py
src/kibicara
__init__.pyconfig.pyemail.pykibicara.pymodel.pyplatformapi.py
platforms
webapi
tests
conftest.py
tox.initests_core
tests_email
tests_telegram
conftest.pytest_api_telegram_create_bot.pytest_api_telegram_delete_bot.pytest_api_telegram_get_bot.pytest_api_telegram_get_bots.py
tests_twitter
frontend
.browserslistrc.editorconfig.gitignoreREADME.mdangular.json
e2e
favicon.svgkarma.conf.jspackage-lock.jsonpackage.jsonsrc/app
app-routing.module.tsapp.component.htmlapp.component.scssapp.component.spec.tsapp.component.tsapp.module.ts
auth
auth-routing.module.tsauth.module.ts
confirm
login
password-reset
password-reset.component.htmlpassword-reset.component.scsspassword-reset.component.spec.tspassword-reset.component.ts
set-password
register
core/api
|
@ -3,19 +3,18 @@
|
|||
|
||||
## Setup Development Environment
|
||||
|
||||
### General
|
||||
|
||||
1. Install `python>=3.10` and development packages
|
||||
(`apt install python3-dev g++` on Ubuntu)
|
||||
2. Run `./setup.sh`
|
||||
|
||||
### Backend
|
||||
|
||||
1. Install `python>=3.8 python3-dev g++`
|
||||
2. Create a virtual environment with `python3 -m venv .venv`
|
||||
3. Activate your dev environment with `source .venv/bin/activate`
|
||||
4. Update pip packages with `pip install -U pip setuptools wheel`
|
||||
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'`
|
||||
0. `cd backend`
|
||||
1. Activate your dev environment with `source .venv/bin/activate`
|
||||
2. Install with `pip install .`
|
||||
3. Turn off production mode: `sudo su -c 'echo "production = 0" >> /etc/kibicara.conf'`
|
||||
|
||||
#### Cheatsheet
|
||||
|
||||
|
@ -23,7 +22,7 @@
|
|||
- Execute Kibicara with `kibicara` (verbose: `kibicara -vvv`)
|
||||
- Interact with Swagger REST-API Documentation: `http://localhost:8000/api/docs`
|
||||
- Test and stylecheck with `tox`
|
||||
- Fix style issues with `black -S kibicara tests`
|
||||
- Fix style issues with `black -S src tests`
|
||||
|
||||
### Frontend
|
||||
|
||||
|
|
Before (image error) Size: 2.6 KiB After (image error) 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