Quest Board - Chore Management Website

A gamified chore management system that turns household tasks into quests with bounties.

Features

• Quest Management: Create, claim, and complete quests
• Role-Based Access: Admin, Editor, and Player roles
• Google OAuth2: Secure authentication
• Quest Lifecycle: Complete workflow from creation to approval
• User Dashboard: Track progress and earnings

Quick Start

Prerequisites

• Docker and Docker Compose
• Node.js 18+
• npm

Development Setup

1. Clone the repository:

   git clone <repository-url>
   cd quest-board

2. Run the setup script:

   ./scripts/setup.sh

3. Set up the database:

   ./scripts/setup-db.sh

4. Start the development environment:

   ./scripts/start-dev.sh

5. Access the application:

   • Frontend: http://localhost:3000
   • Backend API: http://localhost:8000
   • Health Check: http://localhost:8000/health

Project Structure

• backend/ - Express.js backend application
• frontend/ - React frontend application
• docs/ - Project documentation
• scripts/ - Development and deployment scripts

Development

Backend Development

cd backend
npm install
npm run dev

Frontend Development

cd frontend
npm install
npm run dev

Database Management

cd backend
# Generate Prisma client
npx prisma generate

# Run migrations
npx prisma migrate dev

# Seed database
npm run db:seed

# Open Prisma Studio
npx prisma studio

Running Tests

./scripts/run-tests.sh

Documentation

• Architecture - System architecture overview
• MVP Plan - Development roadmap
• API Documentation - API endpoints and usage

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

License

[Add your license here]