49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
# Guilan ACE Backend
|
|
|
|
## Stack
|
|
- Django 5 with Ninja API routers
|
|
- PostgreSQL, Redis, Celery, Gunicorn
|
|
- Prometheus instrumentation through `django-prometheus`
|
|
|
|
## Layout
|
|
```text
|
|
guilan-ace-backend/
|
|
apps/
|
|
users/
|
|
blog/
|
|
gallery/
|
|
events/
|
|
communications/
|
|
payments/
|
|
certificates/
|
|
core/
|
|
config/
|
|
static/
|
|
templates/
|
|
manage.py
|
|
```
|
|
|
|
## Local setup
|
|
```bash
|
|
python -m venv .venv
|
|
.venv\\Scripts\\activate
|
|
pip install -r requirements.txt
|
|
cp .env.example .env
|
|
python manage.py migrate
|
|
python manage.py runserver
|
|
```
|
|
|
|
## Tests
|
|
```bash
|
|
python manage.py test --settings=config.settings.test
|
|
```
|
|
|
|
## Notes
|
|
- Domain routers live under `apps/<domain>/api`.
|
|
- Shared auth helpers live in `core/authentication.py`.
|
|
- Shared base models, admin helpers, choices, and template tags live under `core/`.
|
|
|
|
## Project-local skills
|
|
|
|
Backend implementation guidance is vendored in `.agents/skills/`: `api-and-interface-design`, `deprecation-and-migration`, and `test-driven-development`. Shared team guidance is also included: `grill-me`, `grilling`, `planning-and-task-breakdown`, `documentation-and-adrs`, and `git-workflow-and-versioning`. These directories are part of this repository so they are available after cloning it.
|