docs: Update README with header/logo/branding changes and v0.5 next features

This commit is contained in:
2026-03-09 20:19:46 -05:00
parent e6bbb70288
commit 7ac505da05

View File

@@ -12,6 +12,7 @@ A reactive, interactive dog breeding genealogy mapping system for professional k
- **✅ Interactive Pedigree Visualization** - Multi-generational family trees with zoom/pan - **✅ Interactive Pedigree Visualization** - Multi-generational family trees with zoom/pan
- **✅ Modern UI** - Sleek, dark-themed interface with compact info cards - **✅ Modern UI** - Sleek, dark-themed interface with compact info cards
- **✅ Search & Filter** - Find dogs by name, breed, sex, and more - **✅ Search & Filter** - Find dogs by name, breed, sex, and more
- **✅ Branded Navigation** - Custom logo (br-logo.png) with gold-to-rusty-red gradient title
### Database Architecture ### Database Architecture
- **✅ Clean Schema** - No migrations, fresh installs create correct structure - **✅ Clean Schema** - No migrations, fresh installs create correct structure
@@ -21,7 +22,15 @@ A reactive, interactive dog breeding genealogy mapping system for professional k
- **✅ Heat Cycles** - Breeding cycle tracking - **✅ Heat Cycles** - Breeding cycle tracking
- **✅ Genetic Traits** - Inherited trait mapping - **✅ Genetic Traits** - Inherited trait mapping
### Recently Fixed ### Recently Added (March 9, 2026)
- **✅ Brand Logo** - Custom `br-logo.png` in navbar replacing generic icon
- **✅ Gradient Title** - Gold-to-rusty-red gradient on "BREEDR" brand text
- **✅ Static Asset Serving** - `/static` directory served by Express for branding assets
- **✅ Dev Proxy** - Vite dev server proxies `/static` to Express backend
- **✅ Route Fix** - `/static` and `/uploads` paths no longer fall through to React catch-all
- **✅ Logo Sizing** - Fixed brand logo to 1:1 aspect ratio square
### Previously Fixed
- **✅ Database Schema** - Removed weight/height columns, added litter_id - **✅ Database Schema** - Removed weight/height columns, added litter_id
- **✅ Parent Handling** - Proper sire/dam via parents table - **✅ Parent Handling** - Proper sire/dam via parents table
- **✅ Microchip Field** - Optional, allows multiple dogs without microchips - **✅ Microchip Field** - Optional, allows multiple dogs without microchips
@@ -35,7 +44,7 @@ A reactive, interactive dog breeding genealogy mapping system for professional k
- **Backend**: Node.js/Express API - **Backend**: Node.js/Express API
- **Database**: SQLite (embedded, zero-config) with clean normalized schema - **Database**: SQLite (embedded, zero-config) with clean normalized schema
- **Container**: Single Docker image with multi-stage build - **Container**: Single Docker image with multi-stage build
- **Styling**: CSS custom properties with dark theme - **Styling**: CSS custom properties with dark theme + gradient branding
## Quick Start ## Quick Start
@@ -72,7 +81,7 @@ cp data/breedr.db data/breedr.db.backup
rm data/breedr.db rm data/breedr.db
# Pull latest code # Pull latest code
git pull origin docs/clean-schema-and-roadmap-update git pull origin master
# Rebuild and restart # Rebuild and restart
docker-compose up -d --build docker-compose up -d --build
@@ -134,6 +143,7 @@ breedr/
│ ├── db/ │ ├── db/
│ │ └── init.js # Clean schema (NO migrations) │ │ └── init.js # Clean schema (NO migrations)
│ └── index.js │ └── index.js
├── static/ # Branding assets (br-logo.png, etc.)
├── docs/ # Documentation ├── docs/ # Documentation
├── DATABASE.md # Schema documentation ├── DATABASE.md # Schema documentation
├── ROADMAP.md # Development roadmap ├── ROADMAP.md # Development roadmap
@@ -151,6 +161,7 @@ breedr/
- `GET /api/pedigree/:id` - Generate pedigree tree - `GET /api/pedigree/:id` - Generate pedigree tree
- `GET /api/health` - Health records - `GET /api/health` - Health records
- `GET/POST /api/breeding` - Heat cycles and breeding - `GET/POST /api/breeding` - Heat cycles and breeding
- `GET /static/*` - Branding and static assets
## Upgrading ## Upgrading
@@ -196,6 +207,10 @@ Check server logs for:
If you don't see these logs, ensure `sire_id` and `dam_id` are being sent in the API request. If you don't see these logs, ensure `sire_id` and `dam_id` are being sent in the API request.
### Logo not appearing in navbar
Ensure `br-logo.png` is placed in the `static/` directory at the project root. The file is served at `/static/br-logo.png`.
## Roadmap ## Roadmap
### ✅ Completed ### ✅ Completed
@@ -208,6 +223,8 @@ If you don't see these logs, ensure `sire_id` and `dam_id` are being sent in the
- [x] Parent-child relationships via parents table - [x] Parent-child relationships via parents table
- [x] Modern UI redesign - [x] Modern UI redesign
- [x] Search and filtering - [x] Search and filtering
- [x] Custom brand logo + gradient title
- [x] Static asset serving
### 🚧 In Progress ### 🚧 In Progress
- [ ] Trial pairing simulator - [ ] Trial pairing simulator
@@ -225,7 +242,15 @@ If you don't see these logs, ensure `sire_id` and `dam_id` are being sent in the
## Recent Updates ## Recent Updates
### March 9, 2026 - Clean Database Schema ### March 9, 2026 - Branding & Header Improvements (v0.4.1)
- **Added:** Custom `br-logo.png` brand logo in navbar
- **Added:** Gold-to-rusty-red gradient on "BREEDR" title text
- **Added:** `/static` directory for branding assets served by Express
- **Fixed:** Vite dev proxy for `/static` routes
- **Fixed:** `/static` and `/uploads` paths no longer fall through to React router
- **Fixed:** Brand logo sized as fixed 1:1 square for proper aspect ratio
### March 9, 2026 - Clean Database Schema (v0.4.0)
- **Fixed:** Database schema cleaned up - no migrations - **Fixed:** Database schema cleaned up - no migrations
- **Fixed:** Removed weight/height columns (never implemented) - **Fixed:** Removed weight/height columns (never implemented)
- **Fixed:** Proper parent handling via parents table - **Fixed:** Proper parent handling via parents table