From 543b7d762baf71ab9ff92e2d90e044bee38e095a Mon Sep 17 00:00:00 2001 From: jason Date: Sun, 8 Mar 2026 23:41:29 -0500 Subject: [PATCH] Add microchip field fix migration notice to README --- README.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 83 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8e3eac0..5788fec 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,28 @@ A reactive, interactive dog breeding genealogy mapping system for professional kennel management. +## ⚠️ Important: Database Migration Required + +**If you have an existing BREEDR installation**, you must run a migration to fix the microchip field constraint: + +```bash +# Enter the container +docker exec -it breedr sh + +# Run migration +node server/db/migrate_microchip.js + +# Exit and restart +exit +docker restart breedr +``` + +**What this fixes:** The microchip field now allows multiple dogs without microchips (previously caused "UNIQUE constraint failed" errors). + +**See full details:** [docs/MICROCHIP_FIX.md](docs/MICROCHIP_FIX.md) + +--- + ## Features - **Interactive Pedigree Visualization** - Multi-generational family trees with zoom/pan @@ -10,14 +32,16 @@ A reactive, interactive dog breeding genealogy mapping system for professional k - **Inbreeding Coefficient Calculator** - COI analysis for responsible breeding decisions - **Trial Pairing Simulator** - Preview offspring genetics before breeding - **Document Management** - Digital storage for certificates, contracts, and records +- **Modern UI** - Sleek, dark-themed interface with compact info cards ## Technology Stack -- **Frontend**: React 18 with TypeScript +- **Frontend**: React 18 with modern component design - **Visualization**: React-D3-Tree for pedigree charts - **Backend**: Node.js/Express API - **Database**: SQLite (embedded, zero-config) - **Container**: Single Docker image with multi-stage build +- **Styling**: CSS custom properties with dark theme ## Installation (Unraid) @@ -27,6 +51,7 @@ A reactive, interactive dog breeding genealogy mapping system for professional k ```bash cd /mnt/user/appdata/breedr-build git clone https://git.alwisp.com/jason/breedr.git . +git checkout feature/ui-redesign # For latest UI updates ``` 2. Build the Docker image: @@ -76,9 +101,14 @@ breedr/ │ └── package.json ├── server/ # Node.js backend │ ├── routes/ -│ ├── models/ │ ├── db/ +│ │ ├── init.js +│ │ └── migrate_microchip.js │ └── index.js +├── docs/ # Documentation +│ ├── MICROCHIP_FIX.md +│ ├── UI_REDESIGN.md +│ └── COMPACT_CARDS.md ├── Dockerfile # Multi-stage Docker build ├── docker-compose.yml ├── package.json @@ -102,19 +132,47 @@ SQLite database automatically initializes on first run with tables: - `heat_cycles` - Breeding cycle tracking - `traits` - Genetic trait mapping +## Upgrading + +### From Earlier Versions + +```bash +# Stop container +docker stop breedr + +# Backup your data +cp -r /mnt/user/appdata/breedr /mnt/user/appdata/breedr-backup + +# Pull latest code +cd /mnt/user/appdata/breedr-build +git pull + +# Rebuild image +docker build -t breedr:latest . + +# Start container (will auto-migrate) +docker start breedr + +# Run migration if needed +docker exec -it breedr node server/db/migrate_microchip.js +``` + ## Roadmap -### ✅ Phase 1: Foundation (Current) +### ✅ Phase 1: Foundation (Complete) - [x] Project structure - [x] Docker containerization - [x] Database schema - [x] Basic API endpoints +- [x] Modern UI redesign -### 🚧 Phase 2: Core Features -- [ ] Dog profile management (CRUD) +### 🚧 Phase 2: Core Features (In Progress) +- [x] Dog profile management (CRUD) +- [x] Photo management +- [x] Compact info card design +- [x] Search and filtering - [ ] Interactive pedigree visualization - [ ] Parent-child relationship mapping -- [ ] Basic photo uploads ### 📋 Phase 3: Breeding Tools - [ ] Inbreeding coefficient calculator @@ -122,21 +180,37 @@ SQLite database automatically initializes on first run with tables: - [ ] Heat cycle tracking - [ ] Litter management -### 📋 Phase 4: Health & Genetics +### 📊 Phase 4: Health & Genetics - [ ] Health record management - [ ] Genetic trait tracking - [ ] Document storage -### 📋 Phase 5: Advanced Features +### 🚀 Phase 5: Advanced Features - [ ] PDF pedigree generation - [ ] Reverse pedigree (descendants) - [ ] Advanced search and filters - [ ] Export capabilities +## Recent Updates + +### March 8, 2026 - UI Redesign & Bug Fixes +- **Fixed:** Microchip field UNIQUE constraint (now properly optional) +- **Added:** Migration script for existing databases +- **Redesigned:** Modern dark theme with sleek aesthetics +- **Redesigned:** Compact horizontal info cards (80x80 avatars) +- **Improved:** Dashboard with gradient stats cards +- **Improved:** Navigation bar with glass morphism +- **Enhanced:** Age calculation and display +- **Added:** Sex-colored icons (blue ♂, pink ♀) +- **Added:** Registration number badges + ## License Private use only - All rights reserved ## Support -For issues or questions, contact the system administrator. \ No newline at end of file +For issues or questions: +- Check documentation in `docs/` folder +- Review container logs: `docker logs breedr` +- Contact the system administrator \ No newline at end of file