WAGERBABE DOCS
All Stories
1-1-project-repository-setup-core-dependenciesDraftedEpic 1.1

Story 1.1: Project Repository Setup & Core Dependencies

Status: drafted

Tasks

  • **Task 1: Verify Repository Structure** (AC: #1)
    • 1.1: Audit existing monorepo structure (client/ and server/ directories)
    • 1.2: Verify .gitignore properly excludes .env, node_modules, __pycache__, etc.
    • 1.3: Review root README.md for completeness
  • **Task 2: Client Dependencies Validation** (AC: #2, #3)
    • 2.1: Review existing client/package.json for all required dependencies
    • 2.2: Run `pnpm install` and verify no errors
    • 2.3: Validate TypeScript strict mode configuration in tsconfig.json
    • 2.4: Test dev server startup: `npm run dev` → accessible at localhost:3000
    • 2.5: Verify hot-reload functionality (edit a component, see instant update)
  • **Task 3: Server Dependencies Validation** (AC: #2, #3)
    • 3.1: Review existing server/requirements.txt for all required dependencies
    • 3.2: Create Python virtual environment: `python3 -m venv venv`
    • 3.3: Activate venv and install dependencies: `pip install -r requirements.txt`
    • 3.4: Test server startup: `python -m uvicorn app.main:app --reload`
    • 3.5: Verify server accessible at localhost:8000 and /docs endpoint works
    • 3.6: Verify hot-reload functionality (edit a route, see instant update)
  • **Task 4: Environment Configuration** (AC: #4, #5)
    • 4.1: Create client/.env.example with all required variables documented
    • 4.2: Create server/.env.example with DATABASE_URL, REDIS_URL, JWT_SECRET examples
    • 4.3: Verify .env files are gitignored (test: attempt to commit .env, should fail)
    • 4.4: Document environment setup in README quick start
  • **Task 5: Quick Start Documentation** (AC: #5)
    • 5.1: Update README.md with step-by-step local setup instructions
    • 5.2: Document prerequisites (Node.js 20+, Python 3.13+, pnpm, Redis)
    • 5.3: Add troubleshooting section for common setup issues
    • 5.4: Test quick start with fresh clone (time it, should be <5 minutes)
  • **Task 6: Validation & Testing** (AC: #4)
    • 6.1: Test complete setup from fresh clone
    • 6.2: Verify both client and server run simultaneously without port conflicts
    • 6.3: Test cross-origin requests (client → server API calls work)
    • 6.4: Document setup completion time (target: <5 minutes)

Progress

Tasks0/6
Acceptance Criteria0
Total Tasks6

Navigation

View Epic 1.1All Stories