91 lines
3.2 KiB
Markdown
91 lines
3.2 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
|
||
|
||
### 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`
|
||
|
||
### Local Development
|
||
```bash
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
---
|
||
|
||
## ✅ Core Features
|
||
|
||
### 🐕 Dog & Litter Management
|
||
- **Registry**: Complete CRUD operations for your kennel.
|
||
- **Photo Management**: Multiple high-quality photos per dog.
|
||
- **Litter Tracking**: Link puppies to breeding records automatically.
|
||
- **Champion Tracking**: Badge titled dogs; titles pass "Champion Bloodline" status to offspring.
|
||
|
||
### 🧬 Breeding & Genetics
|
||
- **Interactive Pedigree**: Multi-generational trees with zoom/pan and reverse (descendant) toggles.
|
||
- **Trial Pairing**: Simulator with **COI calculation**, common ancestor identification, and risk badges.
|
||
- **Heat Cycles**: Full calendar with phase tracking, breeding windows, and **projected whelping alerts**.
|
||
|
||
### ⚙️ Kennel Configuration
|
||
- **Settings System**: Centralized management for kennel name, branding, and contact info.
|
||
- **Branding**: Custom logo support and professional dark-themed UI with glassmorphism.
|
||
|
||
---
|
||
|
||
## 🛠️ Technology Stack
|
||
- **Frontend**: React 18, Vite, Lucide Icons
|
||
- **Visualization**: React-D3-Tree
|
||
- **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)
|
||
└── ROADMAP.md # Detailed development history & planned features
|
||
```
|
||
|
||
---
|
||
|
||
## 🕒 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.
|
||
- **v0.5.1**: Projected whelping windows and calendar identifiers.
|
||
- **v0.5.0**: Breeding tools, pairing simulator, and heat cycle calendar.
|
||
|
||
---
|
||
|
||
## ❓ Troubleshooting
|
||
- **COI shows 0.00%?**: Ensure you are on v0.6.1+ to fix direct-relation pathing.
|
||
- **Missing Columns?**: Restart the server; safe migration guards add columns automatically.
|
||
- **Logo not appearing?**: Place `br-logo.png` in the `static/` directory.
|
||
|
||
---
|
||
**Full Documentation & Roadmap**: [ROADMAP.md](ROADMAP.md) | [DATABASE.md](DATABASE.md)
|