199 lines
5.2 KiB
Markdown
199 lines
5.2 KiB
Markdown
# EuchreCamp
|
|
|
|
A comprehensive tournament management and partnership analytics system for the card game Euchre.
|
|
|
|
## Overview
|
|
|
|
EuchreCamp is a full-stack web application built with Next.js 14+ and TypeScript that provides:
|
|
|
|
- **Tournament Management**: Create and manage round-robin, single elimination, double elimination, and Swiss-style tournaments
|
|
- **Partnership Analytics**: Track partnership performance, win rates, and Elo changes between players
|
|
- **Player Profiles**: Display individual player statistics and partnership breakdowns
|
|
- **Admin Dashboard**: Centralized management interface for tournaments, players, and matches
|
|
- **Authentication & Authorization**: Role-based access control with player, tournament_admin, and club_admin roles
|
|
- **Home Page**: Public-facing landing page showing top players, recent tournaments, and club information
|
|
|
|
## Tech Stack
|
|
|
|
- **Framework**: Next.js 14+ (App Router)
|
|
- **Language**: TypeScript
|
|
- **Database**: Prisma ORM with SQLite
|
|
- **Styling**: Tailwind CSS
|
|
- **Authentication**: Better Auth
|
|
- **Form Handling**: React Hook Form + Zod validation
|
|
- **CSV Parsing**: PapaParse
|
|
- **Unit Testing**: Vitest
|
|
- **Acceptance Testing**: Playwright
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
euchre_camp/
|
|
├── src/
|
|
│ ├── app/
|
|
│ │ ├── api/ # API routes
|
|
│ │ ├── auth/ # Authentication pages
|
|
│ │ ├── admin/ # Admin pages
|
|
│ │ ├── players/ # Player pages
|
|
│ │ ├── rankings/ # Rankings page
|
|
│ │ └── components/ # Shared components
|
|
│ ├── lib/ # Utilities and configuration
|
|
│ │ ├── auth.ts # Better Auth configuration
|
|
│ │ ├── prisma.ts # Prisma client
|
|
│ │ ├── permissions.ts # Authorization functions
|
|
│ │ └── elo-utils.ts # Elo calculation utilities
|
|
│ └── __tests__/ # Vitest and Playwright tests
|
|
├── prisma/ # Prisma schema and migrations
|
|
├── docs/ # Documentation
|
|
├── scripts/ # Utility scripts
|
|
└── public/ # Static assets
|
|
```
|
|
|
|
## Features Implemented
|
|
|
|
### Epic 1: Authentication & User Management
|
|
- [x] User registration with email confirmation
|
|
- [x] Login with credentials
|
|
- [x] Password reset flow
|
|
- [x] Session management with Better Auth
|
|
- [x] Role-based access control (player, tournament_admin, club_admin)
|
|
|
|
### Epic 2: Player Profile & Analytics
|
|
- [x] Player profile page with statistics
|
|
- [x] Partnership performance table
|
|
- [x] Win rate and Elo display
|
|
- [x] Direct player stats (gamesPlayed, wins, losses)
|
|
|
|
### Epic 3: Rankings & Public Data
|
|
- [x] Player rankings page
|
|
- [x] Sortable rankings table
|
|
- [x] Public player profiles
|
|
- [x] Home page with top 10 players, recent tournament, club president
|
|
|
|
### Epic 4: Tournament Management
|
|
- [x] Create tournaments
|
|
- [x] Manage participants
|
|
- [x] Create teams
|
|
- [x] View tournament details
|
|
|
|
### Epic 5: Match Recording & CSV Import
|
|
- [x] Record match results via API
|
|
- [x] CSV upload for batch processing
|
|
- [x] Automatic Elo calculation
|
|
- [x] Partnership tracking
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js 20+
|
|
- npm or yarn
|
|
- SQLite3
|
|
|
|
### Installation
|
|
|
|
1. **Clone the repository**
|
|
```bash
|
|
git clone <repository-url>
|
|
cd euchre_camp
|
|
```
|
|
|
|
2. **Install dependencies**
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. **Set up the database**
|
|
```bash
|
|
npx prisma migrate deploy
|
|
npx prisma generate
|
|
```
|
|
|
|
4. **Start the development server**
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
### Environment Variables
|
|
|
|
Create a `.env` file:
|
|
|
|
```env
|
|
DATABASE_URL="file:./dev.db"
|
|
BETTER_AUTH_SECRET="your-secret-key-here"
|
|
BETTER_AUTH_URL="http://localhost:3000"
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Creating a Tournament
|
|
1. Navigate to `/admin/tournaments`
|
|
2. Click "Create Tournament"
|
|
3. Fill in tournament details
|
|
|
|
### Uploading Match Results via CSV
|
|
1. Navigate to `/admin/matches/upload`
|
|
2. Select a tournament
|
|
3. Upload CSV file with Euchre format
|
|
|
|
### Viewing Player Profiles
|
|
Navigate to `/players/[id]/profile` to see statistics, partnerships, and recent games.
|
|
|
|
### Home Page
|
|
Visit `/` to see:
|
|
- Top 10 players by Elo rating
|
|
- Most recent tournament with full match list
|
|
- Club president information
|
|
|
|
## API Endpoints
|
|
|
|
### Tournaments
|
|
- `GET /api/tournaments` - List all tournaments
|
|
- `POST /api/tournaments` - Create new tournament
|
|
|
|
### Matches
|
|
- `GET /api/matches` - List matches
|
|
- `POST /api/matches/upload` - Upload CSV with match results
|
|
|
|
### Authentication
|
|
- `POST /api/auth/sign-up/email` - Register new account
|
|
- `POST /api/auth/sign-in/email` - Login with email/password
|
|
- `POST /api/auth/sign-out` - Logout
|
|
|
|
### Users
|
|
- `GET /api/users/[id]/role` - Get user role
|
|
|
|
## Development
|
|
|
|
```bash
|
|
# Development mode
|
|
npm run dev
|
|
|
|
# Production build
|
|
npm run build
|
|
npm start
|
|
|
|
# Run unit tests
|
|
npm run test
|
|
|
|
# Run acceptance tests
|
|
npm run test:acceptance
|
|
```
|
|
|
|
## User Stories
|
|
|
|
User stories are organized into epics in `docs/USER_STORIES.md`:
|
|
|
|
1. Authentication & User Management
|
|
2. Player Profile & Analytics
|
|
3. Rankings & Public Data
|
|
4. Tournament Management
|
|
5. Match Recording & CSV Import
|
|
6. Club Administration
|
|
7. Mobile Responsiveness
|
|
8. Data Management & Export
|
|
|
|
## License
|
|
|
|
MIT License
|