fix: update documentation and configuration files
This commit is contained in:
@@ -1,13 +1,14 @@
|
||||
# EuchreCamp Next.js Rewrite - Implementation Summary
|
||||
# EuchreCamp Implementation Summary
|
||||
|
||||
## Overview
|
||||
|
||||
Successfully migrated EuchreCamp from Ruby/Hanami to a modern Next.js/TypeScript stack.
|
||||
EuchreCamp is a modern Next.js/TypeScript application for tournament management and partnership analytics in the card game Euchre.
|
||||
|
||||
## Branches
|
||||
|
||||
- **ruby-implementation-backup**: Full backup of the original Ruby/Hanami implementation
|
||||
- **nextjs-rewrite**: Current Next.js implementation (main branch for new development)
|
||||
- **ruby-implementation-backup**: Legacy Ruby/Hanami implementation (archived)
|
||||
- **main**: Current Next.js implementation
|
||||
- **nextjs-rewrite**: Development branch for Next.js features
|
||||
|
||||
## Technology Stack
|
||||
|
||||
@@ -24,8 +25,8 @@ Successfully migrated EuchreCamp from Ruby/Hanami to a modern Next.js/TypeScript
|
||||
### 1. Authentication System
|
||||
- **Login Page** (`/auth/login`): User login with email/password
|
||||
- **Registration Page** (`/auth/register`): New user registration
|
||||
- **Session Management**: JWT-based sessions with NextAuth.js
|
||||
- **Password Reset**: Placeholder for password reset flow
|
||||
- **Session Management**: JWT-based sessions with Better Auth
|
||||
- **Password Reset**: Email-based password reset flow
|
||||
|
||||
### 2. Player Features
|
||||
- **Player Profile** (`/players/[id]/profile`):
|
||||
@@ -101,6 +102,8 @@ Successfully migrated EuchreCamp from Ruby/Hanami to a modern Next.js/TypeScript
|
||||
- Player, User, Event, Team models
|
||||
- Match, EloSnapshot, Partnership models
|
||||
- Full relationships and constraints
|
||||
- **SQLite Database** for development
|
||||
- **Prisma Migrate** for schema management
|
||||
|
||||
## User Stories Covered
|
||||
|
||||
@@ -205,8 +208,19 @@ From the user stories document in `docs/USER_STORIES.md`:
|
||||
|
||||
## Testing
|
||||
|
||||
The application can be tested by:
|
||||
The application has comprehensive test coverage:
|
||||
|
||||
### Unit Tests (Vitest)
|
||||
```bash
|
||||
npm run test
|
||||
```
|
||||
|
||||
### Acceptance Tests (Playwright)
|
||||
```bash
|
||||
npm run test:acceptance
|
||||
```
|
||||
|
||||
### Test Routes
|
||||
1. Start development server: `npm run dev`
|
||||
2. Navigate to `http://localhost:3000`
|
||||
3. Test the following routes:
|
||||
@@ -219,7 +233,9 @@ The application can be tested by:
|
||||
## Notes
|
||||
|
||||
- The database is SQLite-based for development
|
||||
- Authentication uses email/password (no OAuth providers configured yet)
|
||||
- Authentication uses Better Auth with email/password
|
||||
- CSV upload specifically handles Euchre tournament format with Odds/Evens teams
|
||||
- Elo calculation uses standard K-factor of 32
|
||||
- Partnership statistics are automatically updated on match creation
|
||||
- TypeScript provides type safety throughout the application
|
||||
- Next.js App Router handles routing and server-side rendering
|
||||
|
||||
Reference in New Issue
Block a user