readme.md

True Tech Hack 2024

Project of Team "Не грози Южному централу попивая сок у себя на Go"

Architecture

Database Schema

Stack

Python libs

• Aiomisc for DI and service organization
• FastAPI with uvicorn for REST backend with Swagger (can be replaced with aiohttp)
• SqlAlchemy with Alembic for database
• Poetry for requirements management and project config
• YoloV8 Ultralytics for recognizing ramps and stairs

JS stack

• React
• Axios / react-query
• Material UI
• Typescipt

Deployment

For deployment project you should:

1. Create .env file
2. Run docker compose
3. Apply database migrations

Required Envs for Docker Compose

• POSTGRES_USER - user for postgresql
• POSTGRES_PASSWORD - password for postgresql
• POSTGRES_DB - database name for postgresql
• RABBITMQ_USER - rabbitmq user
• RABBITMQ_PASSWORD - rabbitmq password
• APP_SECURITY_SECRET - secret string for passwords
• APP_SECURITY_PRIVATE_KEY - base64 encoded RSA private key for JWT
• APP_YOLO_MODEL_URL - URL for downloading YOLO model (need for building)

Start services

After creating .env file you can start project with command:

docker compose up -d --build

Migrations

You need run command for applying migrations to database

make docker-alembic-upgrade-head

Expluatation

After starting project via docker-compose.yaml you can open docs on:

• Swagger
• Redoc
• OpenAPI JSON