88 lines
3.4 KiB
Markdown
88 lines
3.4 KiB
Markdown
# BREEDR - Dog Breeding Genealogy Management System
|
||
|
||
A reactive, interactive dog breeding genealogy mapping system for professional kennel management.
|
||
|
||
---
|
||
|
||
## 🌟 Recent Highlights (v0.8.0)
|
||
- **✅ Reverse Pedigree** — Toggle between ancestors and descendants view for full lineage tracking.
|
||
- **✅ External Dog Mapping** — Assign parents to external dogs, allowing for full genealogy of outside lines.
|
||
- **✅ Universal Parent Selection** — Select any dog (kennel or external) as a sire/dam from any profile.
|
||
|
||
---
|
||
|
||
## 🚀 Quick Start
|
||
|
||
### 1. Docker Deployment (Recommended)
|
||
```bash
|
||
git clone https://git.alwisp.com/jason/breedr.git
|
||
cd breedr
|
||
docker-compose up -d --build
|
||
```
|
||
Access at: `http://localhost:3000`
|
||
|
||
### 2. Manual Development Setup
|
||
```bash
|
||
npm install
|
||
npm run dev
|
||
```
|
||
> **Note:** The database initializes automatically on first boot. No manual migrations are required.
|
||
|
||
---
|
||
|
||
## 🐕 Managing Your Kennel
|
||
|
||
- **Adding Dogs**: Go to the **Dogs** page, click **Add New Dog**. You can mark dogs as **External** if they aren't in your kennel but are needed for pedigree mapping.
|
||
- **Champion Tracking**: Toggle the **Champion** status to title dogs. Offspring will automatically display the "Champion Bloodline" badge.
|
||
- **Photo Management**: Multiple high-quality photos per dog with a compact gallery view.
|
||
- **Litter Tracking**: Link puppies to breeding records automatically to track weight and health from birth.
|
||
|
||
## 🧬 Breeding & Genetics
|
||
|
||
- **Interactive Pedigree**: 5-generation trees with zoom/pan. Toggle the **Reverse Pedigree** switch to see descendant lineage.
|
||
- **Trial Pairing Simulator**: Calculate Wright's Inbreeding Coefficient (COI) instantly. Identifies common ancestors and providing risk badges (Low/Moderate/High).
|
||
- **Heat Cycles**: Track female cycles on the calendar. Includes **projected whelping alerts** (indigo windows) and expected due dates.
|
||
|
||
---
|
||
|
||
## 🛠️ Technology Stack
|
||
- **Frontend**: React 18, Vite, Lucide Icons
|
||
- **Visualization**: React-D3-Tree, D3.js
|
||
- **Backend**: Node.js, Express.js
|
||
- **Database**: SQLite (Zero-config, safe `ALTER TABLE` migrations)
|
||
- **Deployment**: Multi-stage Docker
|
||
|
||
---
|
||
|
||
## 📂 Project Structure
|
||
```
|
||
breedr/
|
||
├── client/ # React frontend (Pages: Pedigree, Pairing, Calendar, Settings)
|
||
├── server/ # Node.js backend (Routes: Dogs, Pedigree, Breeding, Settings)
|
||
├── static/ # Branded assets (logos, etc.)
|
||
├── data/ # SQLite database storage (mapped in Docker)
|
||
├── uploads/ # Dog photo storage (mapped in Docker)
|
||
└── docs/ # Technical documentation and design history
|
||
```
|
||
|
||
---
|
||
|
||
## 🕒 Release Summary
|
||
|
||
- **v0.8.0** (Mar 2026): Reverse Pedigree & External dog parentage.
|
||
- **v0.7.0** (In Progress): Health & Genetics (OFA clearances, DNA panels).
|
||
- **v0.6.1**: COI calculation fix for direct parent×offspring relations.
|
||
- **v0.6.0**: Champion status tracking & Kennel settings API.
|
||
|
||
---
|
||
|
||
## ❓ Troubleshooting
|
||
- **COI shows 0.00%?**: Ensure both parents are mapped and have shared ancestors.
|
||
- **Missing Columns?**: Restart the server; auto-init guards add columns automatically.
|
||
- **Logo not appearing?**: Place `br-logo.png` in the `static/` directory.
|
||
|
||
---
|
||
|
||
**Full Documentation**:
|
||
[Installation Guide](INSTALL.md) | [Development & Architecture](DEVELOPMENT.md) | [API Reference](API.md) | [Roadmap](ROADMAP.md)
|