393 lines
10 KiB
Markdown
393 lines
10 KiB
Markdown
# 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 (NO sire/dam columns)
|
|
- [x] Parents relationship table for sire/dam tracking
|
|
- [x] Litters breeding records
|
|
- [x] Health records tracking
|
|
- [x] Heat cycles management
|
|
- [x] Traits genetic mapping
|
|
- [x] Indexes and triggers
|
|
- [x] **litter_id column** for linking puppies to litters
|
|
- [x] **Clean schema design** - NO migrations, fresh init only
|
|
|
|
### 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
|
|
- [x] **Parent relationship handling** via parents table
|
|
|
|
---
|
|
|
|
## ✅ 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) via parents table
|
|
- [x] **Proper error handling** for API failures
|
|
|
|
### 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
|
|
- [x] **Compact info cards** (80x80 avatars)
|
|
- [x] **Modern dark theme** with glass morphism
|
|
|
|
### Features Implemented
|
|
- [x] Photo upload and storage
|
|
- [x] Parent-child relationships (via parents table)
|
|
- [x] Basic information tracking
|
|
- [x] Registration numbers
|
|
- [x] Microchip tracking (optional)
|
|
- [x] **Litter linking** with litter_id
|
|
- [x] **Clean database schema** with no migrations
|
|
|
|
---
|
|
|
|
## ✅ Phase 3: Breeding Tools (COMPLETE)
|
|
|
|
### Priority Features
|
|
- [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
|
|
|
|
- [x] **Litter Management** ✅
|
|
- [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)
|
|
- [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
|
|
|
|
- [ ] Heat Cycle Management
|
|
- [ ] Add/edit heat cycles
|
|
- [ ] Track progesterone levels
|
|
- [ ] Calendar view
|
|
- [ ] Breeding date suggestions
|
|
|
|
---
|
|
|
|
## 📊 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
|
|
- [x] DATABASE.md - Complete schema documentation
|
|
- [x] User-facing documentation
|
|
- [ ] 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
|
|
|
|
---
|
|
|
|
## 🆕 Latest Release: v0.4.0 - Clean Database Schema
|
|
|
|
### What's New in This Release
|
|
|
|
#### Database Overhaul ✅
|
|
- ✅ **Clean schema design** - NO migrations, fresh init creates correct structure
|
|
- ✅ **Removed columns:** weight, height (never implemented)
|
|
- ✅ **Added litter_id** column to dogs table with foreign key
|
|
- ✅ **Parents table approach** - NO sire/dam columns in dogs table
|
|
- ✅ **Proper relationships** - Sire/dam stored in separate parents table
|
|
- ✅ **Database documentation** - Comprehensive DATABASE.md file
|
|
|
|
#### API Improvements
|
|
- ✅ **Fixed parent handling** - Properly inserts into parents table
|
|
- ✅ **Added logging** - See exactly what's happening during dog creation
|
|
- ✅ **Error handling** - Graceful fallbacks for missing data
|
|
- ✅ **Query optimization** - Select only existing columns
|
|
|
|
#### Server Improvements
|
|
- ✅ **Removed migrations** - Clean init.js is source of truth
|
|
- ✅ **Simplified startup** - Just calls initDatabase()
|
|
- ✅ **Better logging** - Clear console output with checkmarks
|
|
- ✅ **No schema detection** - Always uses correct structure
|
|
|
|
#### Documentation
|
|
- ✅ **DATABASE.md** - Complete schema reference
|
|
- ✅ **Updated README** - Current features and setup
|
|
- ✅ **Updated ROADMAP** - Accurate progress tracking
|
|
- ✅ **Troubleshooting guide** - Common issues and solutions
|
|
|
|
### Migration Instructions
|
|
|
|
For **fresh installs**, the database will initialize correctly automatically.
|
|
|
|
For **existing installations**, you need to start fresh:
|
|
|
|
```bash
|
|
# Backup your data
|
|
cp data/breedr.db data/breedr.db.backup
|
|
|
|
# Delete old database
|
|
rm data/breedr.db
|
|
|
|
# Pull latest code
|
|
git pull origin docs/clean-schema-and-roadmap-update
|
|
|
|
# Restart application (creates clean database)
|
|
docker-compose restart
|
|
```
|
|
|
|
**Note:** Parent relationship data cannot be automatically migrated due to schema change from columns to table. You'll need to re-enter parent relationships.
|
|
|
|
---
|
|
|
|
## Previous Releases
|
|
|
|
### v0.3.1 - UI Fixes & Error Handling
|
|
- Fixed blank screen issue on Add Dog modal
|
|
- Improved parent selection layout
|
|
- Added comprehensive error handling
|
|
- Enhanced visual design with proper spacing
|
|
|
|
### v0.3.0 - 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
|
|
|
|
---
|
|
|
|
## Current Sprint Focus
|
|
|
|
### Next Up (Priority)
|
|
|
|
#### Option 1: Trial Pairing Simulator (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
|
|
|
|
**Tasks:**
|
|
- Create HealthRecordForm component
|
|
- Add vaccination tracking with expiry alerts
|
|
- Medical history timeline view
|
|
- PDF/image document uploads
|
|
- Health clearance status badges
|
|
|
|
**Estimated Time:** 6-8 hours
|
|
|
|
---
|
|
|
|
### Testing Needed
|
|
- [x] Add/edit dog forms with litter selection
|
|
- [x] Database schema initialization
|
|
- [x] Pedigree tree rendering
|
|
- [x] Zoom/pan controls
|
|
- [x] UI layout fixes
|
|
- [x] Error handling for API failures
|
|
- [x] Parent relationship creation via parents table
|
|
- [ ] Trial pairing simulator
|
|
- [ ] Heat cycle tracking
|
|
- [ ] Health records
|
|
|
|
### 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
|
|
|
|
- **v0.4.0** (Current - March 9, 2026) - Clean Database Schema
|
|
- Complete database overhaul with clean normalized design
|
|
- Removed migrations, fresh init only
|
|
- Parents table for relationships
|
|
- Comprehensive documentation
|
|
|
|
- **v0.3.1** - UI Fixes & Error Handling
|
|
- Fixed blank screen issue on Add Dog modal
|
|
- Improved parent selection layout
|
|
- Added comprehensive error handling
|
|
- Enhanced visual design with proper spacing
|
|
|
|
- **v0.3.0** - 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
|