blaisadmin
36 lines
1.1 KiB
Markdown
36 lines
1.1 KiB
Markdown
# FlockPal
|
|
|
|
FlockPal is a Dockerized TypeScript app for tracking flock health with a clean, modern, and casual UI.
|
|
|
|
## Current scope
|
|
|
|
- Bird profiles with name, tag ID, and species
|
|
- Daily weight recordings
|
|
- 30-day weight graph
|
|
- Postgres-backed storage
|
|
- React frontend and Express backend
|
|
- Security-minded defaults like Helmet, CORS allow-listing, rate limiting, and input validation
|
|
|
|
## Planned next steps
|
|
|
|
- Vet visit history
|
|
- Medication and care reminders
|
|
- Accounts, authorization, and role-based rescue access
|
|
- Billing and plan management for paid organizations with a free rescue tier
|
|
|
|
## Run locally
|
|
|
|
1. Copy `.env.example` to `.env` if you want custom settings.
|
|
2. Start the stack:
|
|
|
|
```bash
|
|
docker compose up --build
|
|
```
|
|
|
|
3. Open `http://localhost:3000`.
|
|
4. The API health check is available at `http://localhost:5000/api/health`.
|
|
|
|
## Notes for monetization and security
|
|
|
|
This starter keeps the data model and deployment simple, but it is intentionally shaped so we can add authentication, organization scoping, audit trails, reminders, and Stripe-style billing later without redesigning the whole app.
|