23 lines
767 B
Markdown
23 lines
767 B
Markdown
|
# FishIQ
|
||
|
|
|
||
|
|
FishIQ is an intelligent fishing companion: trip planning, condition-aware recommendations, personal tackle, catch history, and the Professor Finn conversational guide.
|
||
|
|
|
||
|
|
## First vertical slice
|
||
|
|
|
||
|
|
Lake Eufaula → largemouth bass → Saturday morning → conditions → recommended setup → ask Professor Finn.
|
||
|
|
|
||
|
|
## Start locally
|
||
|
|
|
||
|
|
1. Copy `.env.example` to `.env`.
|
||
|
|
2. Run `docker compose up --build`.
|
||
|
|
3. Open the web app at http://localhost:5173 and the API at http://localhost:8000/api/health/.
|
||
|
|
|
||
|
|
The initial API exposes health, water-body, species, trip, and recommendation endpoints. Seed data is created with:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
docker compose exec api python manage.py seed_demo
|
||
|
|
```
|
||
|
|
|
||
|
|
See `docs/ROADMAP.md` for milestones and `docs/ARCHITECTURE.md` for boundaries.
|
||
|
|
|