generated from bisco/codex-bootstrap
bisco
44 lines
1.4 KiB
Markdown
44 lines
1.4 KiB
Markdown
# HoopScout
|
|
|
|
HoopScout is a private basketball scouting web application for searching and comparing male players across European and selected international leagues.
|
|
|
|
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.
|
|
|
|
## Stack
|
|
|
|
- Docker Compose
|
|
- Django and Django REST Framework
|
|
- PostgreSQL
|
|
- Angular
|
|
|
|
## Local Development
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
docker compose up --build
|
|
```
|
|
|
|
Run database migrations and seed synthetic local scouting data:
|
|
|
|
```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
|
|
```
|
|
|
|
The backend is available at `http://localhost:8000`; the Angular frontend is available at `http://localhost:4200`.
|
|
|
|
## Tests
|
|
|
|
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.
|
|
The demo seed creates a broader scouting board across European leagues plus Australia and New Zealand so filters, sorting, and profile review can be exercised locally.
|