|
|
@@ -1,42 +1,55 @@
|
|
|
# bdlg-2023-server
|
|
|
|
|
|
-This repository host an API that can parse gsheet planning for brass dans la garonne event and manage creating automatic SMS notification for volunteer.
|
|
|
+This repository host an API that can parse gsheet planning for brass dans la garonne event and manage creating automatic
|
|
|
+SMS notification for volunteer.
|
|
|
|
|
|
## Getting started
|
|
|
|
|
|
For running the application
|
|
|
|
|
|
-> git clone ...
|
|
|
-> cd ...
|
|
|
-
|
|
|
-> python -m venv venv
|
|
|
-> venv/scripts/activate
|
|
|
-> poetry install
|
|
|
+```bash
|
|
|
+git clone ...
|
|
|
+cd ...
|
|
|
+python -m venv venv
|
|
|
+venv/scripts/activate
|
|
|
+poetry install
|
|
|
+```
|
|
|
|
|
|
Note, be sure to use python3.11 with this application
|
|
|
|
|
|
-> Copy .env.example to .env and edit it to configure your setup
|
|
|
-> init.sh
|
|
|
-> uvicorn app.main:app --reload
|
|
|
+* Copy .env.example to .env and edit it to configure your setup
|
|
|
+
|
|
|
+```bash
|
|
|
+init.sh
|
|
|
+uvicorn app.main:app --reload
|
|
|
+```
|
|
|
|
|
|
## Debug
|
|
|
|
|
|
-> python -m app.debug
|
|
|
+```bash
|
|
|
+python -m app.debug
|
|
|
+```
|
|
|
|
|
|
Run tests
|
|
|
|
|
|
-> pytest
|
|
|
+```bash
|
|
|
+pytest
|
|
|
+pytest app\test\test_volunteer.py
|
|
|
+```
|
|
|
|
|
|
-Run specific tests
|
|
|
+Run coverage tests
|
|
|
|
|
|
-> pytest app\test\test_volunteer.py
|
|
|
+```bash
|
|
|
+coverage run -m pytest
|
|
|
+coverage html
|
|
|
+```
|
|
|
|
|
|
## Update requirements
|
|
|
|
|
|
-```
|
|
|
-> poetry lock
|
|
|
-> poetry export -f requirements.txt --output requirements.txt --without-hashes
|
|
|
-> poetry export -f requirements.txt --output requirements-dev.txt --without-hashes --with dev
|
|
|
+```bash
|
|
|
+poetry lock
|
|
|
+poetry export -f requirements.txt --output requirements.txt --without-hashes
|
|
|
+oetry export -f requirements.txt --output requirements-dev.txt --without-hashes --with dev
|
|
|
```
|
|
|
|
|
|
## Credit
|