docs(harness): transition to v1 recipe-import phase
- Set current milestone to v1.0 Recipe Import - Rebuilt TODO queue for phased import work (API -> UI -> fallback -> extension) - Marked MVP as functionally complete with manual Docker host validation deferred - Clarified agent task-selection rules to use TODO as authoritative queue
This commit is contained in:
Paul Huliganga
parent
afdc915aa2
commit
0653107f62
|
|
@ -62,10 +62,10 @@ Every time you wake up (new session):
|
|||
|
||||
### What to Work On
|
||||
|
||||
1. **Check ROADMAP.md** for the current milestone
|
||||
2. **Pick the next uncompleted feature** in that milestone
|
||||
3. **If all features done,** move to testing/documentation
|
||||
4. **If milestone complete,** report to Paul for approval before moving to next
|
||||
1. **Check TODO.md first** — treat it as the authoritative queue
|
||||
2. **Pick the first unchecked task** in the current active phase section
|
||||
3. **If all phase tasks are done,** report completion and request milestone transition
|
||||
4. **Do not jump to backlog phases** unless TODO explicitly marks the new phase active
|
||||
|
||||
### How to Break Down Tasks
|
||||
|
||||
|
|
|
|||
209
TODO.md
209
TODO.md
|
|
@ -1,185 +1,62 @@
|
|||
# TODO — Recipe Manager
|
||||
|
||||
**Last Updated:** 2026-03-24
|
||||
**Current Milestone:** MVP (v0.1)
|
||||
**Last Updated:** 2026-03-25
|
||||
**Current Milestone:** v1.0 — Recipe Import
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Active Tasks
|
||||
## ✅ MVP (v0.1) Status
|
||||
|
||||
### DevOps
|
||||
- [ ] Test local deployment *(Unable to run `docker compose up` in environment: docker is unavailable. Manual test required on host.)*
|
||||
MVP is functionally complete (core app + docs + tests).
|
||||
|
||||
### Documentation
|
||||
- [x] Write API documentation (docs/api.md)
|
||||
- [x] Create user guide (docs/user-guide.md)
|
||||
- [ ] Add setup instructions to README
|
||||
- [ ] Document first architecture decisions (ADRs)
|
||||
### Completed
|
||||
- Backend API (recipes + tags)
|
||||
- Frontend UI (list/detail/form/cook mode)
|
||||
- Search + tag management + error handling
|
||||
- Dockerfiles + docker-compose
|
||||
- API docs + user guide + README setup
|
||||
- ADR-001 (sql.js decision)
|
||||
|
||||
### Deferred / Manual Host Validation
|
||||
- [ ] Manual Docker host test (`docker compose up`) on host machine with Docker installed
|
||||
|
||||
---
|
||||
|
||||
## ✅ Completed Tasks
|
||||
## 🎯 Active Tasks — v1.0 Recipe Import
|
||||
|
||||
### 2026-03-24
|
||||
- **Docker Compose orchestration** (Iteration 16)
|
||||
- Created docker-compose.yml with backend and frontend services
|
||||
- Backend service: Node.js API on port 3000 with named volume for SQLite persistence (recipe-data:/app/data)
|
||||
- Frontend service: nginx on port 8080, depends on backend health check
|
||||
- Configured nginx to proxy /api/* requests to backend service (http://backend:3000)
|
||||
- Updated frontend API client (services/api.ts) to use relative URLs (/api instead of http://localhost:3000/api)
|
||||
- Added Vite dev server proxy configuration for local development (proxies /api to localhost:3000)
|
||||
- Implemented health checks for both services (backend: GET /api/recipes, frontend: GET /health)
|
||||
- Configured restart policies (unless-stopped) and service dependencies
|
||||
- Created internal Docker network (recipe-network) for service communication
|
||||
- Added comprehensive documentation in docs/docker-compose.md (architecture, usage, troubleshooting, testing)
|
||||
- Supports both local development (npm run dev with Vite proxy) and production deployment (Docker Compose)
|
||||
- Verified: YAML syntax valid, all 5 files committed
|
||||
- Next: Test local deployment (docker compose up -d && docker compose ps)
|
||||
### Phase 1: URL Import Foundation
|
||||
- [ ] Add backend import endpoint: `POST /api/import/url`
|
||||
- [ ] Implement Schema.org Recipe JSON-LD parser service
|
||||
- [ ] Normalize parsed recipe into internal Recipe draft format
|
||||
- [ ] Add import endpoint tests (valid recipe page, non-recipe page, malformed JSON-LD)
|
||||
|
||||
- **Frontend Dockerfile implementation** (Iteration 15)
|
||||
- Created multi-stage Dockerfile for frontend build and deployment
|
||||
- Builder stage: Node.js 22 Alpine with npm ci, TypeScript compilation, Vite production build
|
||||
- Production stage: nginx Alpine serving static assets from /usr/share/nginx/html
|
||||
- Added nginx.conf with SPA routing (try_files fallback to index.html for React Router)
|
||||
- Configured gzip compression for text files (HTML, CSS, JS, JSON)
|
||||
- Added security headers (X-Frame-Options, X-Content-Type-Options, X-XSS-Protection)
|
||||
- Implemented aggressive caching for static assets (1 year expiry with immutable flag)
|
||||
- Created health check endpoint at /health for container orchestration
|
||||
- Created frontend/.dockerignore to optimize build context (exclude node_modules, dist, tests, etc.)
|
||||
- Added comprehensive documentation in docs/docker-frontend.md (build strategy, nginx config, optimization, deployment)
|
||||
- Verified: npm run build succeeds (Docker build pending Docker availability in environment)
|
||||
- Expected image size: ~50MB (nginx:alpine ~25MB + static assets ~25MB)
|
||||
### Phase 2: Import UI
|
||||
- [ ] Add “Import from URL” UI page/form in frontend
|
||||
- [ ] Show parsed preview (title, ingredients, steps, source URL)
|
||||
- [ ] Allow edit-before-save flow, then save to existing create recipe API
|
||||
- [ ] Add frontend error states (invalid URL, parse failure, timeout)
|
||||
|
||||
- **Backend Dockerfile implementation** (Iteration 14)
|
||||
- Created multi-stage Dockerfile using Node.js 22 Alpine for optimized image size
|
||||
- Builder stage: npm ci, TypeScript compilation
|
||||
- Production stage: production dependencies only, built JavaScript
|
||||
- Included database schema file (schema.sql) required by migration script
|
||||
- Created .dockerignore to exclude unnecessary files (node_modules, tests, frontend, docs)
|
||||
- Added startup command that runs migrations then starts Express server
|
||||
- Created documentation in docs/docker-backend.md with build/run instructions
|
||||
- Verified: npm build succeeds, all 34 tests pass
|
||||
### Phase 3: Fallback Parsing + Hardening
|
||||
- [ ] Add heuristic fallback parser when Schema.org missing
|
||||
- [ ] Add timeout/retry + user-friendly import failure messages
|
||||
- [ ] Add logging/telemetry for import success/failure reasons
|
||||
|
||||
- **Error handling and toast notifications** (Iteration 13)
|
||||
- Created Toast component with slide-in animation for success/error/info/warning messages
|
||||
- Created useToast hook for managing toast notifications globally
|
||||
- Added ToastContext to App.tsx for sharing toast functionality across components
|
||||
- Implemented ErrorBoundary component to catch and display React errors gracefully
|
||||
- Updated RecipeDetailPage to show toast notifications for all operations (create, update, delete, tag management)
|
||||
- Updated TagSelector to use toast notifications instead of alert()
|
||||
- Added proper error handling for all API operations with user-friendly messages
|
||||
- Added loading states for delete operation
|
||||
- Added CSS animation for toast slide-in effect
|
||||
- Verified: All 34 backend tests passing (16 recipe + 18 tag tests)
|
||||
- Verified: Frontend builds successfully with TypeScript compilation
|
||||
|
||||
- **Text search verification** (Iteration 12)
|
||||
- Verified backend RecipeRepository searches across title, description, and ingredients using SQL LIKE
|
||||
- Confirmed Zod validation schema accepts search parameter in GET /api/recipes
|
||||
- Verified integration test coverage (search test passes in recipes.test.ts)
|
||||
- Confirmed frontend useRecipes hook passes search query to API
|
||||
- Verified UI implementation: RecipeListPage has search input with clear button
|
||||
- All 34 tests passing (16 recipe + 18 tag tests)
|
||||
- Feature was already implemented in previous iterations, now confirmed working
|
||||
|
||||
- **Tag management implementation**
|
||||
- Backend: Created Tag types, TagRepository, TagService
|
||||
- Backend: Implemented tag CRUD API endpoints (GET, POST, PUT, DELETE /api/tags)
|
||||
- Backend: Implemented tag assignment endpoints (POST/DELETE /api/tags/recipes/:id/tags)
|
||||
- Backend: Added 18 integration tests for tag functionality (all passing)
|
||||
- Frontend: Updated API client with tag methods
|
||||
- Frontend: Created useTags hook for tag state management
|
||||
- Frontend: Created TagSelector component for tag selection in forms
|
||||
- Frontend: Updated RecipeForm to support tag assignment
|
||||
- Frontend: Updated RecipeDetailPage to display and manage recipe tags
|
||||
- Frontend: Updated RecipeCard to display tags
|
||||
- Frontend: Added tag filter UI to RecipeListPage (note: full filtering pending backend support)
|
||||
- Verified: All 34 backend tests passing (16 recipe tests + 18 tag tests)
|
||||
- Verified: Frontend builds successfully with TypeScript compilation
|
||||
|
||||
- **Cook mode UI implementation**
|
||||
- Implemented full cooking interface with ingredient and step checklists
|
||||
- Added progress tracking with visual progress bars
|
||||
- Integrated Screen Wake Lock API to prevent screen sleep during cooking
|
||||
- Created touch-friendly UI with large text and clear spacing
|
||||
- Added completion celebration when all steps are done
|
||||
- Included loading and error states with navigation back to recipe detail
|
||||
- Verified TypeScript compilation and Vite build succeed
|
||||
|
||||
- **Recipe detail/edit page implementation**
|
||||
- Created useRecipe hook for fetching single recipe with loading/error states
|
||||
- Created RecipeForm component with full validation (title, ingredients, instructions required)
|
||||
- Implemented RecipeDetailPage with view/edit modes
|
||||
- Added create new recipe functionality (/recipe/new route)
|
||||
- Implemented edit existing recipe with form pre-population
|
||||
- Added delete recipe with confirmation dialog
|
||||
- Included metadata display (servings, prep time, cook time)
|
||||
- Added navigation to cook mode and back to list
|
||||
- Verified TypeScript compilation and Vite build succeed
|
||||
|
||||
- **Recipe list page implementation**
|
||||
- Created API client service (src/services/api.ts) with all CRUD operations
|
||||
- Created useRecipes hook for data fetching with search and pagination
|
||||
- Created RecipeCard component for displaying individual recipes
|
||||
- Implemented RecipeListPage with search bar, empty state, loading state, error handling
|
||||
- Added grid layout with responsive design (1-3 columns)
|
||||
- Implemented "Load More" button for pagination
|
||||
- Added recipe count display and meta information (servings, time, last cooked)
|
||||
- Verified TypeScript compilation and Vite build succeed
|
||||
|
||||
- **React Router setup**
|
||||
- Updated main.tsx to wrap App in BrowserRouter
|
||||
- Configured routes in App.tsx with navigation header
|
||||
- Created page components: RecipeListPage, RecipeDetailPage, CookModePage, NotFoundPage
|
||||
- Added active link highlighting in navigation
|
||||
- Defined routes: / (list), /recipe/new, /recipe/:id, /recipe/:id/cook, * (404)
|
||||
- Verified build and dev server work correctly
|
||||
|
||||
- **Tailwind CSS configuration**
|
||||
- Installed Tailwind CSS v4 with PostCSS and Autoprefixer
|
||||
- Installed @tailwindcss/postcss plugin for v4 compatibility
|
||||
- Created tailwind.config.js with content paths
|
||||
- Created postcss.config.js with Tailwind and Autoprefixer
|
||||
- Updated index.css with Tailwind directives
|
||||
- Updated App.tsx to demonstrate Tailwind utility classes
|
||||
- Verified build and dev server work correctly
|
||||
|
||||
- **Frontend initialization**
|
||||
- Created frontend/ directory with Vite + React + TypeScript
|
||||
- Installed React Router 7
|
||||
- Set up project structure (components/, hooks/, pages/, services/, types/)
|
||||
- Created Recipe and Tag TypeScript interfaces
|
||||
- Verified dev server starts successfully on port 5173
|
||||
- Added frontend README with development instructions
|
||||
|
||||
- **Recipe CRUD API implementation** (commit e2599b8)
|
||||
- Implemented GET /api/recipes (list with pagination & search)
|
||||
- Implemented GET /api/recipes/:id (get single recipe)
|
||||
- Implemented POST /api/recipes (create recipe)
|
||||
- Implemented PUT /api/recipes/:id (update recipe)
|
||||
- Implemented DELETE /api/recipes/:id (delete recipe)
|
||||
- Added Zod validation schemas for all endpoints
|
||||
- Created layered architecture (Routes → Services → Repositories)
|
||||
- Wrote 16 integration tests (all passing)
|
||||
- Database auto-save functionality
|
||||
|
||||
### 2026-03-23
|
||||
- Backend initialization (Node.js + Express)
|
||||
- TypeScript setup with strict mode
|
||||
- SQLite schema creation with sql.js
|
||||
### Phase 4: Browser Extension (after URL import stable)
|
||||
- [ ] Scaffold browser extension project (Manifest v3)
|
||||
- [ ] Add “Send to Recipe Manager” action to call import API
|
||||
- [ ] Add extension settings for Recipe Manager base URL
|
||||
|
||||
---
|
||||
|
||||
## 📋 Backlog (Post-MVP)
|
||||
## 📋 Backlog (Post-v1)
|
||||
|
||||
### v1.0
|
||||
- [ ] Browser extension for recipe scraping
|
||||
### v1.1
|
||||
- [ ] Recipe scaling (adjust servings)
|
||||
- [ ] Print styles
|
||||
- [ ] Advanced search filters
|
||||
- [ ] Random recipe suggestion
|
||||
|
||||
### v2.0
|
||||
### v2.0 (AI Features)
|
||||
- [ ] AI ingredient substitutions
|
||||
- [ ] Meal planning
|
||||
- [ ] Shopping list generation
|
||||
|
|
@ -189,18 +66,18 @@
|
|||
|
||||
## 🚧 Blocked / Needs Decision
|
||||
|
||||
- **Tag filtering in recipe list:** Currently shows UI but doesn't filter results. Need to add backend support for filtering recipes by tag_id parameter in GET /api/recipes endpoint, or implement a separate endpoint that returns recipes with their tags. (Low priority - tags work for assignment/display, just not list filtering yet)
|
||||
- **CopyMeThat export path:** confirm whether Anne/Elizabeth can export directly, or we rely on URL import + browser extension.
|
||||
- **Tag filtering in recipe list:** currently UI-only, backend filter by tag_id pending.
|
||||
|
||||
---
|
||||
|
||||
## Notes for Agents
|
||||
|
||||
- Check this file before starting work
|
||||
- Move completed tasks to "Completed" section
|
||||
- Add new tasks as you discover them
|
||||
- Flag blockers for Paul's attention
|
||||
- Keep this file current (update after each commit)
|
||||
- Work from top to bottom in the **Active Tasks — v1.0** section.
|
||||
- Pick the **first unchecked task** only.
|
||||
- One task = one commit.
|
||||
- If blocked: mark task with reason and continue next unblocked task only with explicit note.
|
||||
|
||||
---
|
||||
|
||||
_This is your working task list. Keep it honest and up-to-date._
|
||||
_This is the authoritative task queue for harness iterations._
|
||||
|
|
|
|||
Loading…
Reference in New Issue