[doc] Document pytest dependencies and webUI development requirements

This commit is contained in:
missytake 2023-03-18 13:49:04 +01:00 committed by Gitea
parent 1d1eb47fe6
commit eef6f0c473

View file

@ -10,7 +10,7 @@
3. Activate your dev environment with `source .venv/bin/activate` 3. Activate your dev environment with `source .venv/bin/activate`
4. Update pip packages with `pip install -U pip setuptools wheel` 4. Update pip packages with `pip install -U pip setuptools wheel`
5. Install with `pip install .` 5. Install with `pip install .`
6. Install development dependencies with `pip install tox black` 6. Install development dependencies with `pip install tox black pytest pytest-aiohttp`
7. Add git-hook to run test and stylecheck before commmit with 7. Add git-hook to run test and stylecheck before commmit with
`ln -s ../../git-hooks/pre-commit .git/hooks/pre-commit` `ln -s ../../git-hooks/pre-commit .git/hooks/pre-commit`
8. Add git-hook to check commmit message format with 8. Add git-hook to check commmit message format with
@ -140,6 +140,8 @@ development team.
- `model.py` - `model.py`
- `webapi.py` - `webapi.py`
2. Import your bot in `kibicara/webapi/__init__.py`. 2. Import your bot in `kibicara/webapi/__init__.py`.
3. Generate the FastAPI stuff
4. Generate the angular components for the kibicara-frontend from the FastAPI stuff
### Explanation ### Explanation
@ -202,3 +204,5 @@ A bot should have at least this functionality:
- e.g. Twitter via posts or retweets - e.g. Twitter via posts or retweets
- e.g. Telegram via direct message from the bot - e.g. Telegram via direct message from the bot
- e.g. E-Mail via e-mail to the user's address - e.g. E-Mail via e-mail to the user's address
- Web Interface (hood admins)