feat: bootstrap HoopScout scouting app

README.md

@@ -1,73 +1,42 @@
-# codex-bootstrap
+# HoopScout
 
-A repository template for AI-assisted development with Codex.
+HoopScout is a private basketball scouting web application for searching and comparing male players across European and selected international leagues.
 
-This template defines a repeatable workflow for using Codex as an autonomous coding agent that can create branches, modify code, run Docker-based tests, update documentation, write ADRs, and commit changes using Conventional Commits.
+The MVP focuses on local usage for a restricted group of users. It provides a Django REST API, PostgreSQL persistence, and an Angular scouting dashboard.
 
-## Purpose
+## Stack
 
-Use this template to bootstrap repositories where Codex must operate with clear rules, minimal changes, pragmatic TDD, security guardrails, and explicit documentation requirements.
+- Docker Compose
+- Django and Django REST Framework
+- PostgreSQL
+- Angular
 
-## Repository structure
+## Local Development
 
-```text
-.
-├── AGENTS.md
-├── README.md
-├── .codex/
-│   ├── project.md
-│   ├── workflow.md
-│   ├── security.md
-│   ├── quality.md
-│   ├── orchestration.md
-│   ├── prompts/
-│   │   ├── task.md
-│   │   ├── bugfix.md
-│   │   ├── refactor.md
-│   │   ├── security-review.md
-│   │   └── documentation.md
-│   ├── agents/
-│   │   ├── architect.md
-│   │   ├── developer.md
-│   │   ├── reviewer.md
-│   │   ├── security-reviewer.md
-│   │   ├── test-engineer.md
-│   │   └── documentation-writer.md
-│   └── profiles/
-│       ├── docker.md
-│       ├── ansible.md
-│       └── python.md
-└── docs/
-    ├── adr/
-    │   └── 0000-template.md
-    ├── architecture.md
-    ├── deployment.md
-    ├── operations.md
-    ├── security.md
-    ├── testing.md
-    └── runbook.md
+```bash
+cp .env.example .env
+docker compose up --build
 ```
 
-## How to use
+Run database migrations and seed synthetic local scouting data:
 
-1. Copy this template into a new or existing repository.
-2. Edit `.codex/project.md` and configure:
-   - project mode;
-   - enabled profiles;
-   - Docker-based test command;
-   - branch naming rules if needed.
-3. Add project-specific details to the documentation under `docs/`.
-4. When asking Codex to work on a task, use one of the prompt templates under `.codex/prompts/`.
+```bash
+docker compose run --rm backend python manage.py migrate
+docker compose run --rm backend python manage.py seed_demo_data
+docker compose run --rm backend python manage.py createsuperuser
+```
 
-## Core rules
+The backend is available at `http://localhost:8000`; the Angular frontend is available at `http://localhost:4200`.
 
-Codex must:
+## Tests
 
-- start work from `develop`;
-- create a dedicated `feature/`, `fix/`, or `hotfix/` branch;
-- use pragmatic TDD;
-- keep changes minimal and focused;
-- run the configured Docker-based test command before completion;
-- update documentation and ADRs when needed;
-- produce a final report with summary, tests, risks, and rollback notes;
-- commit using Conventional Commits.
+All tests are run inside Docker containers:
+
+```bash
+docker compose run --rm backend ruff check .
+docker compose run --rm backend pytest
+docker compose run --rm frontend npm test
+docker compose config
+```
+
+Demo data is synthetic. RealGM, Proballers, or other external sources must be integrated only through authorized APIs or documented, compliant import workflows.