Files
breedr/ROADMAP.md

313 lines
7.4 KiB
Markdown
Raw Normal View History

# BREEDR Development Roadmap
## ✅ Phase 1: Foundation (COMPLETE)
### Infrastructure
- [x] Docker multi-stage build configuration
- [x] SQLite database with automatic initialization
- [x] Express.js API server
- [x] React 18 frontend with Vite
- [x] Git repository structure
### Database Schema
- [x] Dogs table with core fields
- [x] Parents relationship table
- [x] Litters breeding records
- [x] Health records tracking
- [x] Heat cycles management
- [x] Traits genetic mapping
- [x] Indexes and triggers
### API Endpoints
- [x] `/api/dogs` - Full CRUD operations
- [x] `/api/pedigree` - Tree generation and COI calculator
- [x] `/api/litters` - Breeding records
- [x] `/api/health` - Health tracking
- [x] `/api/breeding` - Heat cycles and whelping calculator
- [x] Photo upload with Multer
---
## ✅ Phase 2: Core Functionality (COMPLETE)
### Dog Management
- [x] Add new dogs with full form
- [x] Edit existing dogs
- [x] View dog details
- [x] List all dogs with search/filter
- [x] Upload multiple photos per dog
- [x] Delete photos
- [x] Parent selection (sire/dam)
### User Interface
- [x] Dashboard with statistics
- [x] Dog list with grid view
- [x] Dog detail pages
- [x] Modal forms for add/edit
- [x] Photo management UI
- [x] Search and sex filtering
- [x] Responsive navigation
### Features Implemented
- [x] Photo upload and storage
- [x] Parent-child relationships
- [x] Basic information tracking
- [x] Registration numbers
- [x] Microchip tracking
---
2026-03-09 00:11:31 -05:00
## ✅ Phase 3: Breeding Tools (COMPLETE)
### Priority Features
2026-03-09 00:11:31 -05:00
- [x] **Interactive pedigree tree visualization**
- [x] Integrate React-D3-Tree
- [x] Show 3-5 generations
- [x] Click to navigate
- [x] Zoom and pan controls
- [x] Beautiful color-coded nodes
- [x] Male/Female distinction
- [ ] Trial Pairing Simulator
- [ ] Select sire and dam
- [ ] Display COI calculation
- [ ] Show common ancestors
- [ ] Risk assessment display
- [ ] Heat Cycle Management
- [ ] Add/edit heat cycles
- [ ] Track progesterone levels
- [ ] Calendar view
- [ ] Breeding date suggestions
2026-03-09 00:11:31 -05:00
- [x] **Litter Management****NEW**
- [x] Create litter records
- [x] Link puppies to litter
- [x] Track whelping details
- [x] Auto-link parent relationships
- [x] Database migration for litter_id
- [x] Enhanced API endpoints
- [x] Dual parent selection mode (litter/manual)
---
## 📋 Phase 4: Health & Genetics (PLANNED)
### Health Records
- [ ] Add health test results
- [ ] Vaccination tracking
- [ ] Medical history timeline
- [ ] Document uploads (PDFs, images)
- [ ] Alert for expiring vaccinations
### Genetic Tracking
- [ ] Track inherited traits
- [ ] Color genetics calculator
- [ ] Health clearance status
- [ ] Link traits to ancestors
---
## 📋 Phase 5: Advanced Features (PLANNED)
### Pedigree Tools
- [ ] Reverse pedigree (descendants view)
- [ ] PDF pedigree generation
- [ ] Export to standard formats
- [ ] Print-friendly layouts
- [ ] Multi-generation COI analysis
### Breeding Planning
- [ ] Breeding calendar
- [ ] Heat cycle predictions
- [ ] Expected whelping alerts
- [ ] Breeding history reports
### Search & Analytics
- [ ] Advanced search filters
- [ ] By breed, color, age
- [ ] By health clearances
- [ ] By registration status
- [ ] Statistics dashboard
- [ ] Breeding success rates
- [ ] Average litter sizes
- [ ] Popular pairings
---
## 📋 Phase 6: Polish & Optimization (PLANNED)
### User Experience
- [ ] Loading states for all operations
- [ ] Better error messages
- [ ] Confirmation dialogs
- [ ] Undo functionality
- [ ] Keyboard shortcuts
### Performance
- [ ] Image optimization
- [ ] Lazy loading
- [ ] API caching
- [ ] Database query optimization
### Mobile
- [ ] Touch-friendly interface
- [ ] Mobile photo capture
- [ ] Responsive tables
- [ ] Offline mode
### Documentation
- [ ] User manual
- [ ] API documentation
- [ ] Video tutorials
- [ ] FAQ section
---
## Future Enhancements (BACKLOG)
### Multi-User Support
- [ ] User authentication
- [ ] Role-based permissions
- [ ] Activity logs
- [ ] Shared access
### Integration
- [ ] Import from other systems
- [ ] Export to Excel/CSV
- [ ] Integration with kennel clubs
- [ ] Backup to cloud storage
### Advanced Genetics
- [ ] DNA test result tracking
- [ ] Genetic diversity analysis
- [ ] Breed-specific calculators
- [ ] Health risk predictions
### Kennel Management
- [ ] Breeding contracts
- [ ] Buyer tracking
- [ ] Financial records
- [ ] Stud service management
---
2026-03-09 00:11:31 -05:00
## 🎉 Latest Release: v0.3.0 - Litter Management & Pedigree Visualization
### What's New in This Release
#### Litter Management System
- ✅ Fixed "no such column: sire" error when adding puppies
- ✅ Database migration adds `litter_id` column to dogs table
- ✅ New LitterForm component for creating/editing litters
- ✅ Enhanced litter API with puppy linking endpoints
- ✅ Dual parent selection mode in DogForm:
- Link to existing litter (auto-populates parents)
- Manual parent selection (traditional method)
- ✅ Auto-creation of parent relationships when linking to litter
#### Interactive Pedigree Visualization
- ✅ Beautiful tree visualization using React-D3-Tree
- ✅ Shows 5 generations of ancestry
- ✅ Color-coded nodes: Blue for males, Pink for females
- ✅ Interactive controls:
- Zoom in/out buttons
- Reset view
- Mouse wheel zoom
- Click and drag to pan
- ✅ Node information display:
- Dog name
- Registration number
- Birth year
- Sex indicator (♂/♀)
- ✅ Leverages existing COI calculator backend
- ✅ Horizontal tree layout for better readability
### Migration Instructions
1. Pull the feature branch:
```bash
git checkout feature/litter-management-and-pedigree
```
2. Run database migration:
```bash
node server/db/migrate_litter_id.js
```
3. Install new dependencies:
```bash
cd client && npm install
```
4. Restart the server:
```bash
npm run dev
```
### Documentation
See [FEATURE_IMPLEMENTATION.md](./FEATURE_IMPLEMENTATION.md) for:
- Detailed technical documentation
- Architecture decisions
- Usage examples
- API changes
- Testing checklist
---
## Current Sprint Focus
### Next Up (Priority)
2026-03-09 00:11:31 -05:00
1. **Trial Pairing Tool**
- Create pairing form
- Display COI calculation
- Show common ancestors
- Add recommendation system
2026-03-09 00:11:31 -05:00
2. **Heat Cycle Management**
- Add/edit heat cycles
- Track progesterone levels
- Calendar view
- Breeding date suggestions
3. **Enhanced Litter Features**
- Puppy batch addition
- Photo gallery per litter
- Whelping countdown
- Expected vs actual puppy count tracking
### Testing Needed
2026-03-09 00:11:31 -05:00
- [x] Add/edit dog forms with litter selection
- [x] Database migration execution
- [x] Pedigree tree rendering
- [x] Zoom/pan controls
- [ ] Trial pairing simulator
- [ ] Heat cycle tracking
### Known Issues
- None currently
---
## How to Contribute
1. Pick a feature from "Priority Features"
2. Create a feature branch: `feature/feature-name`
3. Implement with tests
4. Update this roadmap
5. Submit for review
## Version History
2026-03-09 00:11:31 -05:00
- **v0.3.0** (Current) - Litter Management & Interactive Pedigree
- Added litter_id to dogs table
- Implemented LitterForm component
- Created PedigreeView with React-D3-Tree
- Enhanced DogForm with dual parent selection
- Fixed "no such column: sire" error
- Added comprehensive documentation
- **v0.2.0** - Dog CRUD operations complete
- **v0.1.0** - Initial foundation with API and database