Files
breedr/ROADMAP.md

7.4 KiB

BREEDR Development Roadmap

Phase 1: Foundation (COMPLETE)

Infrastructure

  • Docker multi-stage build configuration
  • SQLite database with automatic initialization
  • Express.js API server
  • React 18 frontend with Vite
  • Git repository structure

Database Schema

  • Dogs table with core fields
  • Parents relationship table
  • Litters breeding records
  • Health records tracking
  • Heat cycles management
  • Traits genetic mapping
  • Indexes and triggers

API Endpoints

  • /api/dogs - Full CRUD operations
  • /api/pedigree - Tree generation and COI calculator
  • /api/litters - Breeding records
  • /api/health - Health tracking
  • /api/breeding - Heat cycles and whelping calculator
  • Photo upload with Multer

Phase 2: Core Functionality (COMPLETE)

Dog Management

  • Add new dogs with full form
  • Edit existing dogs
  • View dog details
  • List all dogs with search/filter
  • Upload multiple photos per dog
  • Delete photos
  • Parent selection (sire/dam)

User Interface

  • Dashboard with statistics
  • Dog list with grid view
  • Dog detail pages
  • Modal forms for add/edit
  • Photo management UI
  • Search and sex filtering
  • Responsive navigation

Features Implemented

  • Photo upload and storage
  • Parent-child relationships
  • Basic information tracking
  • Registration numbers
  • Microchip tracking

Phase 3: Breeding Tools (COMPLETE)

Priority Features

  • Interactive pedigree tree visualization

    • Integrate React-D3-Tree
    • Show 3-5 generations
    • Click to navigate
    • Zoom and pan controls
    • Beautiful color-coded nodes
    • 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
  • Litter Management NEW

    • Create litter records
    • Link puppies to litter
    • Track whelping details
    • Auto-link parent relationships
    • Database migration for litter_id
    • Enhanced API endpoints
    • 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

🎉 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:

    git checkout feature/litter-management-and-pedigree
    
  2. Run database migration:

    node server/db/migrate_litter_id.js
    
  3. Install new dependencies:

    cd client && npm install
    
  4. Restart the server:

    npm run dev
    

Documentation

See FEATURE_IMPLEMENTATION.md for:

  • Detailed technical documentation
  • Architecture decisions
  • Usage examples
  • API changes
  • Testing checklist

Current Sprint Focus

Next Up (Priority)

  1. Trial Pairing Tool

    • Create pairing form
    • Display COI calculation
    • Show common ancestors
    • Add recommendation system
  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

  • Add/edit dog forms with litter selection
  • Database migration execution
  • Pedigree tree rendering
  • 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

  • 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