feat: added documentation for backend

This commit is contained in:
ITQ
2025-02-18 23:58:34 +03:00
parent 6aaf7fdaed
commit 314ee30836
+51 -13
View File
@@ -48,29 +48,27 @@ uv sync --no-dev
#### Running #### Running
##### In dev mode ##### Apply migrations
Apply migrations:
```bash ```bash
uv run python manage.py migrate uv run python manage.py migrate
``` ```
Start project: ##### Start celery worker
```bash
celery -A config worker -l INFO
```
##### Start server
In dev mode:
```bash ```bash
uv run python manage.py runserver uv run python manage.py runserver
``` ```
##### In prod mode In prod mode:
Apply migrations:
```bash
uv run python manage.py migrate
```
Start project:
```bash ```bash
uv run gunicorn config.wsgi uv run gunicorn config.wsgi
@@ -102,8 +100,48 @@ Customize environment with `docker run` command (or bind .env file to container)
### Run docker image ### Run docker image
#### Backend
```bash ```bash
docker run -p 8080:8080 --name adnova-backend adnova-backend docker run -p 8080:8080 --name adnova-backend adnova-backend
``` ```
#### Celery worker
```bash
docker run --name adnova-celery-worker adnova-backend celery -A config worker -l INFO
```
Backend will be available on localhost:8080. Backend will be available on localhost:8080.
## Testing
### Clone the project
```bash
git clone https://gitlab.prodcontest.ru/2025-final-projects-back/devitq.git
```
### Go to the project directory
```bash
cd devitq/solution/services/backend
```
### Install dependencies
```bash
uv sync --all-extras
```
### Run tests
```bash
uv run coverage run --source="." manage.py test
```
### Check coverage
```bash
uv run coverage report
```