feat: added READMEs for main services

This commit is contained in:
ITQ
2025-02-12 11:37:44 +03:00
parent e2cfc639af
commit 30c0e593ae
2 changed files with 192 additions and 0 deletions
+109
View File
@@ -0,0 +1,109 @@
# AdNova Backend
## Prerequisites
Ensure you have the following installed on your system:
- [Python](https://www.python.org/) (>=3.10,<3.12)
- [uv](https://docs.astral.sh/uv/)
- [Docker](https://www.docker.com/) (for containerized setup)
## Basic setup
### Installation
#### 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
```
#### Customize environment
```bash
cp .env.template .env
```
And setup env vars according to your needs.
#### Install dependencies
##### For dev environment
```bash
uv sync --all-extras
```
##### For prod environment
```bash
uv sync --no-dev
```
#### Running
##### In dev mode
Apply migrations:
```bash
uv run python manage.py migrate
```
Start project:
```bash
uv run python manage.py runserver
```
##### In prod mode
Apply migrations:
```bash
uv run python manage.py migrate
```
Start project:
```bash
uv run gunicorn config.wsgi
```
## Containerized setup
### 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
```
### Build docker image
```bash
docker build -t adnova-backend .
```
### Customize environment
Customize environment with `docker run` command (or bind .env file to container), for all environment vars and default values see [.env.template](./.env.template).
### Run docker image
```bash
docker run -p 8080:8080 --name adnova-backend adnova-backend
```
Backend will be available on localhost:8080.
+83
View File
@@ -0,0 +1,83 @@
# AdNova Telegram Bot
## Prerequisites
Ensure you have the following installed on your system:
- [Python](https://www.python.org/) (>=3.10,<3.12)
- [uv](https://docs.astral.sh/uv/)
- [Docker](https://www.docker.com/) (for containerized setup)
## Basic setup
### Installation
#### 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/telegram_bot
```
#### Customize environment
```bash
cp .env.template .env
```
And setup env vars according to your needs.
#### Install dependencies
##### For dev environment
```bash
uv sync --all-extras
```
##### For prod environment
```bash
uv sync --no-dev
```
#### Running
```bash
uv run python main.py
```
## Containerized setup
### 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/telegram_bot
```
### Build docker image
```bash
docker build -t adnova-telegram_bot .
```
### Customize environment
Customize environment with `docker run` command (or bind .env file to container), for all environment vars and default values see [.env.template](./.env.template).
### Run docker image
```bash
docker run --name adnova-telegram_bot adnova-telegram_bot
```