Greg/books
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
books/docs/prd/index.md
Greg fa8acef423 Epic 1, Story 1.1: Project Initialization & Repository Setup 
- Initialize Git repository with main branch
- Create comprehensive .gitignore for Node.js, React, and environment files
- Set up directory structure (frontend/, backend/, docs/)
- Create detailed README.md with project overview and setup instructions
- Add .env.example with all required environment variables
- Configure Prettier for consistent code formatting

All acceptance criteria met:
✅ Git repository initialized with appropriate .gitignore
✅ Directory structure matches Technical Assumptions
✅ README.md created with project overview and setup docs
✅ .env.example file with all required environment variables
✅ Prettier config files added for code formatting consistency

🤖 Generated with Claude Code (https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-01 15:12:30 +01:00

72 lines
7.0 KiB
Markdown
Raw Permalink Blame History

# Book Reading Tracker - Product Requirements Document (PRD)
## Table of Contents
- [Book Reading Tracker - Product Requirements Document (PRD)](#table-of-contents)
- [Goals and Background Context](./goals-and-background-context.md)
- [Goals](./goals-and-background-context.md#goals)
- [Background Context](./goals-and-background-context.md#background-context)
- [Change Log](./goals-and-background-context.md#change-log)
- [Requirements](./requirements.md)
- [Functional](./requirements.md#functional)
- [Non Functional](./requirements.md#non-functional)
- [User Interface Design Goals](./user-interface-design-goals.md)
- [Overall UX Vision](./user-interface-design-goals.md#overall-ux-vision)
- [Key Interaction Paradigms](./user-interface-design-goals.md#key-interaction-paradigms)
- [Core Screens and Views](./user-interface-design-goals.md#core-screens-and-views)
- [Accessibility](./user-interface-design-goals.md#accessibility)
- [Branding](./user-interface-design-goals.md#branding)
- [Target Device and Platforms](./user-interface-design-goals.md#target-device-and-platforms)
- [Technical Assumptions](./technical-assumptions.md)
- [Repository Structure](./technical-assumptions.md#repository-structure)
- [Service Architecture](./technical-assumptions.md#service-architecture)
- [Testing Requirements](./technical-assumptions.md#testing-requirements)
- [Additional Technical Assumptions and Requests](./technical-assumptions.md#additional-technical-assumptions-and-requests)
- [Epic List](./epic-list.md)
- [Epic 1: Foundation & Core Infrastructure](./epic-list.md#epic-1-foundation-core-infrastructure)
- [Epic 2: Book Search & Management](./epic-list.md#epic-2-book-search-management)
- [Epic 3: Progress Logging & Pace Calculation](./epic-list.md#epic-3-progress-logging-pace-calculation)
- [Epic 4: Calendar View & Data Visualization](./epic-list.md#epic-4-calendar-view-data-visualization)
- [Epic 5: PWA Features & Production Readiness](./epic-list.md#epic-5-pwa-features-production-readiness)
- [Epic 1: Foundation & Core Infrastructure](./epic-1-foundation-core-infrastructure.md)
- [Story 1.1: Project Initialization & Repository Setup](./epic-1-foundation-core-infrastructure.md#story-11-project-initialization-repository-setup)
- [Story 1.2: Frontend Scaffolding with Vite + React](./epic-1-foundation-core-infrastructure.md#story-12-frontend-scaffolding-with-vite-react)
- [Story 1.3: Backend Scaffolding with Node.js + Express](./epic-1-foundation-core-infrastructure.md#story-13-backend-scaffolding-with-nodejs-express)
- [Story 1.4: Database Schema Definition with Prisma](./epic-1-foundation-core-infrastructure.md#story-14-database-schema-definition-with-prisma)
- [Story 1.5: Database Setup & Initial Migration](./epic-1-foundation-core-infrastructure.md#story-15-database-setup-initial-migration)
- [Story 1.6: Docker Configuration for Local Development](./epic-1-foundation-core-infrastructure.md#story-16-docker-configuration-for-local-development)
- [Story 1.7: CI/CD Deployment Configuration for Coolify](./epic-1-foundation-core-infrastructure.md#story-17-cicd-deployment-configuration-for-coolify)
- [Epic 2: Book Search & Management](./epic-2-book-search-management.md)
- [Story 2.1: Open Library API Integration Service](./epic-2-book-search-management.md#story-21-open-library-api-integration-service)
- [Story 2.2: Book Search API Endpoint](./epic-2-book-search-management.md#story-22-book-search-api-endpoint)
- [Story 2.3: Add Book API Endpoint](./epic-2-book-search-management.md#story-23-add-book-api-endpoint)
- [Story 2.4: List Active Books API Endpoint](./epic-2-book-search-management.md#story-24-list-active-books-api-endpoint)
- [Story 2.5: Book Search UI Component](./epic-2-book-search-management.md#story-25-book-search-ui-component)
- [Story 2.6: Add Book Form UI](./epic-2-book-search-management.md#story-26-add-book-form-ui)
- [Story 2.7: Book List Display UI](./epic-2-book-search-management.md#story-27-book-list-display-ui)
- [Epic 3: Progress Logging & Pace Calculation](./epic-3-progress-logging-pace-calculation.md)
- [Story 3.1: Log Progress API Endpoint](./epic-3-progress-logging-pace-calculation.md#story-31-log-progress-api-endpoint)
- [Story 3.2: Pace Calculation Service](./epic-3-progress-logging-pace-calculation.md#story-32-pace-calculation-service)
- [Story 3.3: Get Book Progress API Endpoint](./epic-3-progress-logging-pace-calculation.md#story-33-get-book-progress-api-endpoint)
- [Story 3.4: Enhanced Book List API with Progress Data](./epic-3-progress-logging-pace-calculation.md#story-34-enhanced-book-list-api-with-progress-data)
- [Story 3.5: Log Progress Modal UI](./epic-3-progress-logging-pace-calculation.md#story-35-log-progress-modal-ui)
- [Story 3.6: Progress Visualization on Book Cards](./epic-3-progress-logging-pace-calculation.md#story-36-progress-visualization-on-book-cards)
- [Story 3.7: Book Detail Screen with Progress Details](./epic-3-progress-logging-pace-calculation.md#story-37-book-detail-screen-with-progress-details)
- [Epic 4: Calendar View & Data Visualization](./epic-4-calendar-view-data-visualization.md)
- [Story 4.1: Get Reading Logs for Calendar API Endpoint](./epic-4-calendar-view-data-visualization.md#story-41-get-reading-logs-for-calendar-api-endpoint)
- [Story 4.2: Calendar Component UI (Basic)](./epic-4-calendar-view-data-visualization.md#story-42-calendar-component-ui-basic)
- [Story 4.3: Calendar Screen Integration](./epic-4-calendar-view-data-visualization.md#story-43-calendar-screen-integration)
- [Story 4.4: Calendar View on Book Detail Screen](./epic-4-calendar-view-data-visualization.md#story-44-calendar-view-on-book-detail-screen)
- [Epic 5: PWA Features & Production Readiness](./epic-5-pwa-features-production-readiness.md)
- [Story 5.1: PWA Manifest & Service Worker Setup](./epic-5-pwa-features-production-readiness.md#story-51-pwa-manifest-service-worker-setup)
- [Story 5.2: Offline Support & Sync Strategy](./epic-5-pwa-features-production-readiness.md#story-52-offline-support-sync-strategy)
- [Story 5.3: Mobile Responsiveness & Touch Optimization](./epic-5-pwa-features-production-readiness.md#story-53-mobile-responsiveness-touch-optimization)
- [Story 5.4: Performance Optimization](./epic-5-pwa-features-production-readiness.md#story-54-performance-optimization)
- [Story 5.5: Error Handling & User Feedback](./epic-5-pwa-features-production-readiness.md#story-55-error-handling-user-feedback)
- [Story 5.6: Production Deployment to Coolify](./epic-5-pwa-features-production-readiness.md#story-56-production-deployment-to-coolify)
- [Story 5.7: Testing & Quality Assurance](./epic-5-pwa-features-production-readiness.md#story-57-testing-quality-assurance)
- [Checklist Results Report](./checklist-results-report.md)
- [Next Steps](./next-steps.md)
- [UX Expert Prompt](./next-steps.md#ux-expert-prompt)
- [Architect Prompt](./next-steps.md#architect-prompt)
Reference in New Issue View Git Blame Copy Permalink