jason/breedr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update ROADMAP for v0.5.0 - mark Pairing Simulator and Heat Cycle Calendar complete

Browse Source
This commit is contained in:
jason
2026-03-09 20:40:45 -05:00
parent 2290680a22
commit da585c9e35
1 changed files with 83 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

168
ROADMAP.md
View File

@@ -74,7 +74,7 @@
## ✅ Phase 3: Breeding Tools (COMPLETE)
### Priority Features
### Pedigree & Genetics
- [x] **Interactive pedigree tree visualization**
- [x] Integrate React-D3-Tree
- [x] Show 3-5 generations
@@ -93,30 +93,38 @@
- [x] Dual parent selection mode (litter/manual)
- [x] UI fix for proper layout and error handling
- [ ] Trial Pairing Simulator
- [ ] Select sire and dam
- [ ] Display COI calculation
- [ ] Show common ancestors
- [ ] Risk assessment display
- [x] **Trial Pairing Simulator** ✅ *(March 9, 2026)*
- [x] Sire and dam selection dropdowns
- [x] COI calculation display with color coding
- [x] Common ancestors table (sire-gen / dam-gen columns)
- [x] Risk badge: Low (<5%) / Moderate (5-10%) / High (>10%)
- [x] `/pairing` route + navbar link
- [x] `POST /api/pedigree/trial-pairing` backend
- [ ] Heat Cycle Management
- [ ] Add/edit heat cycles
- [ ] Track progesterone levels
- [ ] Calendar view
- [ ] Breeding date suggestions
- [x] **Heat Cycle Calendar** ✅ *(March 9, 2026)*
- [x] Full month grid calendar (Sun–Sat) with prev/next navigation
- [x] Color-coded day cells by cycle phase
- [x] Start Heat Cycle modal (female dropdown + date picker)
- [x] Cycle Detail modal with phase breakdown
- [x] Breeding date logging inline
- [x] Whelping estimate (earliest/expected/latest)
- [x] Active cycles list with phase badge + day counter
- [x] `GET /api/breeding/heat-cycles` endpoint
- [x] `GET /api/breeding/heat-cycles/:id/suggestions` endpoint
---
## 📋 Phase 4: Health & Genetics (PLANNED)
## 📋 Phase 4: Health & Genetics (NEXT UP)
### Health Records
- [ ] Add health test results
- [ ] Vaccination tracking
- [ ] Medical history timeline
### Health Records *(Priority 1)*
- [ ] Health records list view per dog
- [ ] Add/edit health test results
- [ ] Vaccination tracking with expiry alerts
- [ ] Medical history timeline view
- [ ] Document uploads (PDFs, images)
- [ ] Alert for expiring vaccinations
- [ ] Health clearance status badges on dog cards
### Genetic Tracking
### Genetic Tracking *(Priority 2)*
- [ ] Track inherited traits
- [ ] Color genetics calculator
- [ ] Health clearance status
@@ -134,10 +142,10 @@
- [ ] Multi-generation COI analysis
### Breeding Planning
- [ ] Breeding calendar
- [ ] Heat cycle predictions
- [ ] Expected whelping alerts
- [ ] Heat cycle predictions (based on cycle history)
- [ ] Expected whelping alerts / push notifications
- [ ] Breeding history reports
- [ ] iCal export for cycle events
### Search & Analytics
- [ ] Advanced search filters
@@ -181,7 +189,13 @@
---
## Future Enhancements (BACKLOG)
## Future / Extended Features (BACKLOG)
### Progesterone Tracking *(Moved from Phase 3)*
- [ ] Log progesterone level readings per heat cycle
- [ ] Chart progesterone curve over cycle days
- [ ] LH surge detection
- [ ] Optimal breeding day prediction from levels
### Multi-User Support
- [ ] User authentication
@@ -209,77 +223,54 @@
---
## 🌕 Current Sprint: v0.5.0
## 🌕 Current Sprint: v0.6.0
### ✅ Completed This Sprint
- [x] Custom `br-logo.png` brand logo in navbar
- [x] Gold-to-rusty-red gradient on BREEDR title
- [x] `/static` directory served by Express
- [x] Vite dev proxy for `/static`
- [x] Fixed route fall-through for `/static` and `/uploads`
- [x] Brand logo fixed to 1:1 aspect ratio
### ✅ Completed This Sprint (v0.5.0)
- [x] Trial Pairing Simulator — `/pairing` route, COI%, risk badge, common ancestors
- [x] Heat Cycle Calendar — month grid, phase color coding, start-cycle modal
- [x] Cycle Detail modal — breeding windows, inline breeding date, whelping estimate
- [x] New backend endpoints: `GET /heat-cycles`, `GET /heat-cycles/:id/suggestions`
- [x] Removed `progesterone_peak_date` from POST/PUT (moved to extended backlog)
### 🚧 Next Up (Priority Order)
### 🔧 Next Up (Priority Order)
#### Option 1: Trial Pairing Simulator (Recommended) 👍
#### Option 1: Health Records System (Recommended) 👆
**Complexity:** Medium | **Impact:** High | **User Value:** Excellent
**Why this is recommended:**
- Leverages existing COI calculator backend
- Provides immediate breeding decision support
- High value feature for breeders
- Relatively quick to implement
**Tasks:**
- Create `PairingSimulator` component
- Add sire/dam selection dropdowns
- Display COI calculation results
- Show common ancestors table
- Add genetic risk assessment
- Color-coded recommendations (green/yellow/red)
**Estimated Time:** 4-6 hours
---
#### Option 2: Heat Cycle Management
**Complexity:** Medium-High | **Impact:** Medium | **User Value:** Good
**Why consider this:**
- Natural extension of litter management
- Helps with breeding planning
- Provides calendar functionality
**Tasks:**
- Create `HeatCycleForm` component
- Add calendar view with heat cycle tracking
- Track progesterone levels
- Implement breeding date suggestions
- Whelping date calculator
**Estimated Time:** 6-8 hours
---
#### Option 3: Health Records System
**Complexity:** Medium | **Impact:** High | **User Value:** Excellent
**Why consider this:**
- Important for breeding decisions
- Vaccination tracking is valuable
- Document management adds utility
- Natural complement to existing dog profiles
- Vaccination expiry alerts are high day-to-day utility
- Clearance badges on dog cards improve trust at a glance
- Builds toward breeding decision support
**Tasks:**
- Create `HealthRecordForm` component
- Add vaccination tracking with expiry alerts
- Medical history timeline view
- PDF/image document uploads
- Health clearance status badges
- Health records list/timeline per dog on DogDetail page
- Vaccination tracking with expiry date + alert badge
- Health clearance status badges (OFA, CERF, etc.)
- Optional document/PDF upload
**Estimated Time:** 6-8 hours
---
#### Option 2: Genetic Trait Tracking
**Complexity:** Medium | **Impact:** Medium | **User Value:** Good
**Why consider this:**
- Visual color/coat genetics are important for breeders
- Links naturally to pedigree view
- Useful for marketing/listing dogs
**Tasks:**
- Trait entry form (coat color, pattern, carried traits)
- Display traits on dog detail page
- Predicted trait calculator for trial pairings
**Estimated Time:** 5-7 hours
---
### Testing Needed
- [x] Add/edit dog forms with litter selection
- [x] Database schema initialization
@@ -291,8 +282,8 @@
- [x] Brand logo display and sizing
- [x] Gradient title rendering
- [x] Static asset serving in prod and dev
- [ ] Trial pairing simulator
- [ ] Heat cycle tracking
- [ ] Trial pairing simulator (end-to-end)
- [ ] Heat cycle calendar (start cycle, detail modal, whelping)
- [ ] Health records
### Known Issues
@@ -302,14 +293,21 @@
## How to Contribute
1. Pick a feature from "Priority Features"
2. Create a feature branch: `feature/feature-name`
1. Pick a feature from "Next Up" above
2. Create a feature branch: `feat/feature-name`
3. Implement with tests
4. Update this roadmap
5. Submit for review
4. Update this roadmap and README.md
5. Submit PR for review
## Version History
- **v0.5.0** (March 9, 2026) - Breeding Tools Complete
- Trial Pairing Simulator: COI calculator, risk badge, common ancestors
- Heat Cycle Calendar: month grid, phase windows, start-cycle modal
- Cycle Detail: breeding windows, inline breeding date, whelping estimate
- New API: `GET /heat-cycles`, `GET /heat-cycles/:id/suggestions`
- Progesterone tracking moved to extended backlog
- **v0.4.1** (March 9, 2026) - Branding & Header Improvements
- Custom br-logo.png in navbar
- Gold-to-rusty-red gradient title