test_task_crm/README.md

30 lines
861 B
Markdown

# Test Task CRM
FastAPI backend template that follows the architecture described in the system prompt: async SQLAlchemy ORM, Alembic-ready models, service/repository layers, JWT auth helpers, and Pydantic v2 schemas.
## Quick start
1. Create a `.env` file based on variables in `app/core/config.py`.
2. Install dependencies:
```bash
uv sync
```
3. Run the development server:
```bash
uv run python main.py
```
## Project layout
```
app/
api/ # FastAPI routers and dependencies
core/ # Settings, database, security helpers
models/ # SQLAlchemy models and Pydantic schemas
repositories/ # Data access layer (SQLAlchemy ORM usage)
services/ # Business logic (auth, users, etc.)
```
Add new routers under `app/api/v1`, repositories under `app/repositories`, and keep business rules inside `app/services`.