initial commit
This commit is contained in:
45
README.md
Normal file
45
README.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# 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.sample .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/`.
|
||||
|
||||
Reference in New Issue
Block a user