phase2: add modular apps, auth scaffolding, and base template routing
This commit is contained in:
44
README.md
44
README.md
@ -5,26 +5,34 @@ Production-minded basketball scouting and player search platform built with Djan
|
||||
## Stack
|
||||
|
||||
- Python 3.12+
|
||||
- Django + Django Templates + HTMX (no SPA)
|
||||
- Django + Django Templates + HTMX (server-rendered)
|
||||
- PostgreSQL
|
||||
- Redis
|
||||
- Celery + Celery Beat
|
||||
- nginx
|
||||
- Docker / Docker Compose
|
||||
|
||||
## Repository Structure
|
||||
## Project Structure
|
||||
|
||||
```text
|
||||
.
|
||||
├── apps/
|
||||
│ ├── core/
|
||||
│ ├── users/
|
||||
│ ├── players/
|
||||
│ ├── competitions/
|
||||
│ ├── teams/
|
||||
│ ├── stats/
|
||||
│ ├── scouting/
|
||||
│ ├── providers/
|
||||
│ └── ingestion/
|
||||
├── config/
|
||||
│ └── settings/
|
||||
├── nginx/
|
||||
├── requirements/
|
||||
├── static/
|
||||
├── templates/
|
||||
├── tests/
|
||||
├── docker-compose.yml
|
||||
├── Dockerfile
|
||||
└── entrypoint.sh
|
||||
└── tests/
|
||||
```
|
||||
|
||||
## Setup
|
||||
@ -41,7 +49,7 @@ cp .env.example .env
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
3. Apply migrations (if not using auto migrations):
|
||||
3. Apply migrations (if auto-migrate disabled):
|
||||
|
||||
```bash
|
||||
docker compose exec web python manage.py migrate
|
||||
@ -59,6 +67,18 @@ docker compose exec web python manage.py createsuperuser
|
||||
- Admin: http://localhost/admin/
|
||||
- Health endpoint: http://localhost/health/
|
||||
|
||||
## Authentication Routes
|
||||
|
||||
- Signup: `/users/signup/`
|
||||
- Login: `/users/login/`
|
||||
- Logout: `/users/logout/`
|
||||
- Dashboard (auth required): `/dashboard/`
|
||||
|
||||
## Tailwind Integration Strategy
|
||||
|
||||
Phase 2 keeps styling minimal and framework-neutral using `static/css/main.css`.
|
||||
For upcoming phases, Tailwind will be integrated as a build step that emits compiled CSS into `static/css/` (e.g., via standalone Tailwind CLI or PostCSS in a dedicated frontend tooling container), while templates stay server-rendered.
|
||||
|
||||
## Development Commands
|
||||
|
||||
Run tests:
|
||||
@ -73,12 +93,6 @@ Run Django shell:
|
||||
docker compose exec web python manage.py shell
|
||||
```
|
||||
|
||||
Collect static files:
|
||||
|
||||
```bash
|
||||
docker compose exec web python manage.py collectstatic --noinput
|
||||
```
|
||||
|
||||
## Migrations
|
||||
|
||||
Create migration:
|
||||
@ -93,10 +107,6 @@ Apply migration:
|
||||
docker compose exec web python manage.py migrate
|
||||
```
|
||||
|
||||
## Ingestion / Sync (Phase Placeholder)
|
||||
|
||||
Data provider ingestion flow will be added in a later phase with adapter-based provider isolation.
|
||||
|
||||
## GitFlow
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for branch model and PR workflow.
|
||||
|
||||
Reference in New Issue
Block a user