Initial commit: raceplanner project scaffold

This commit is contained in:
Denis Urs Rudolph
2026-04-03 20:43:01 +02:00
commit fbfa367c16
25 changed files with 1795 additions and 0 deletions
BIN
View File
Binary file not shown.
BIN
View File
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,2 @@
schema: spec-driven
created: 2026-04-03
@@ -0,0 +1,115 @@
## Context
This is a new race planning application built from scratch. The system needs to support two primary user types: organizers who create and manage events, and participants who register for and attend events. The application requires user authentication, event management, registration workflows, payment tracking, and communication features.
## Goals / Non-Goals
**Goals:**
- Build a full-stack web application with clear separation of concerns
- Implement secure user authentication with role-based access
- Create intuitive event management for organizers
- Enable seamless participant registration workflow
- Provide real-time dashboard metrics
- Support payment tracking (initially manual recording, extensible to online payments)
**Non-Goals:**
- Real-time chat or messaging between users
- Complex payment processing integration (Phase 1 is manual tracking only)
- Mobile native apps (web-responsive only)
- Social media integrations
- Advanced analytics or reporting (basic metrics only)
## Decisions
### Architecture: Full-stack with REST API
**Decision**: Use a client-server architecture with a REST API backend and SPA frontend.
**Rationale**: This provides clear separation of concerns, enables independent development of frontend and backend, and supports future mobile app development if needed.
**Alternatives considered**:
- Server-side rendered (SSR) application - Rejected: Less interactive UI, harder to build dashboard features
- GraphQL API - Rejected: Adds complexity, REST is sufficient for current requirements
### Tech Stack: .NET Backend + Next.js Frontend (Bun Runtime)
**Decision**:
- **Backend**: .NET (C# with ASP.NET Core Web API)
- **Frontend**: Next.js with TypeScript, running on Bun runtime (instead of Node.js)
**Rationale**:
- **.NET Backend**: Robust framework with excellent performance, built-in dependency injection, Entity Framework Core for PostgreSQL integration, and strong typing with C#
- **Next.js on Bun**: Bun provides faster startup times and better performance than Node.js, while Next.js offers excellent React framework with SSR/SSG capabilities
- Full-stack TypeScript experience (C# on backend, TypeScript on frontend)
- Clear separation allows independent scaling and deployment
**Alternatives considered**:
- Python/Django - Rejected: Less suitable for real-time dashboard updates
- Node.js backend - Rejected: Prefer .NET's strong typing and enterprise features
- Node.js runtime for frontend - Rejected: Bun offers better performance for Next.js
### Database: PostgreSQL
**Decision**: Use PostgreSQL as the primary database with normalized schema.
**Rationale**: ACID compliance for financial data (payments), mature ecosystem, good ORM support.
**Alternatives considered**:
- MongoDB - Rejected: Less suitable for relational data (users, events, registrations)
- SQLite - Rejected: Won't scale to multiple concurrent organizers
### Authentication: JWT with httpOnly cookies
**Decision**: Use JWT tokens stored in httpOnly cookies for session management.
**Rationale**: Stateless authentication, secure against XSS, supports role-based claims.
**Alternatives considered**:
- Session-based auth - Rejected: Requires server-side session store, adds complexity
- OAuth only - Rejected: Still need local auth for initial version
### Payment Tracking: Manual + Extensible
**Decision**: Start with manual payment recording, design for future integration.
**Rationale**: Faster MVP, payment processing can be added later without schema changes.
## Risks / Trade-offs
**Risk**: Payment data security without integrated processor
**Mitigation**: Encrypt sensitive fields, audit logs, plan for processor integration in Phase 2
**Risk**: Dashboard performance with many events/registrations
**Mitigation**: Implement pagination, consider caching layer for metrics, database indexing
**Risk**: Email delivery reliability
**Mitigation**: Use transactional email service (SendGrid/Mailgun), implement retry logic
**Trade-off**: Manual payment recording requires organizer trust
**Acceptance**: Documented limitation for MVP, roadmap includes automated processing
## Migration Plan
Not applicable - this is a new application with no existing data to migrate.
Deployment strategy:
1. Deploy database schema
2. Deploy backend API
3. Deploy frontend application
4. Configure DNS and SSL
5. Create initial admin user
## Open Questions (Resolved)
**Decision Log:**
1. **Email verification before allowing registration?**
- **Decision**: Not needed for MVP
- **Rationale**: Keep signup friction minimal for initial launch; can add later if needed
2. **Event categories/tags for filtering?**
- **Decision**: Yes, implement event categories/tags
- **Rationale**: Improves event discoverability and participant experience
3. **Can participants edit registrations after submission?**
- **Decision**: Yes, support registration cancellation
- **Rationale**: Users need flexibility to manage their commitments
4. **File uploads (event images, participant documents)?**
- **Decision**: Not needed for MVP
- **Rationale**: Keep initial scope focused; can add as separate feature later
@@ -0,0 +1,34 @@
## Why
We need a dedicated race planning application to help race organizers and participants coordinate event logistics, track registrations, manage schedules, and communicate important information. Currently, organizers rely on fragmented tools (spreadsheets, email chains, social media) which leads to confusion and missed details.
## What Changes
- Create a new web application for race planning and management
- Implement user authentication and role-based access (organizers vs participants)
- Build event creation and management system with scheduling
- Add registration workflow with payment tracking
- Create communication tools (announcements, notifications)
- Build dashboard for tracking key metrics and participant data
## Capabilities
### New Capabilities
- `user-auth`: User authentication and authorization system with role-based access control
- `event-management`: Create, edit, and manage race events with schedules and details
- `event-categorization`: Categorize events with tags and categories for filtering
- `registration-system`: Participant registration workflow with form submission, editing, and cancellation
- `payment-tracking`: Track registration payments and payment status
- `announcements`: Event announcements and communication system
- `dashboard`: Dashboard for organizers to view metrics and manage events
### Modified Capabilities
<!-- No existing specs to modify -->
## Impact
- New web application codebase
- Database schema for users, events, registrations
- API endpoints for all CRUD operations
- Frontend UI components for all features
- Integration with payment processor (future consideration)
Binary file not shown.
@@ -0,0 +1,39 @@
## ADDED Requirements
### Requirement: Event announcements
The system SHALL allow organizers to post announcements for their events.
#### Scenario: Create announcement
- **WHEN** organizer creates announcement with title and content
- **THEN** system saves announcement with timestamp
- **AND** associates with specific event
#### Scenario: Announcement visibility
- **WHEN** participant views event page
- **THEN** system displays all published announcements
- **AND** sorts by newest first
### Requirement: Announcement notifications
The system SHALL notify registered participants of new announcements.
#### Scenario: New announcement notification
- **WHEN** organizer publishes announcement
- **THEN** system sends notification to all registered participants
- **AND** includes announcement title and link
#### Scenario: Mark as read
- **WHEN** participant views announcement
- **THEN** system marks notification as read
### Requirement: Announcement management
The system SHALL allow organizers to edit and delete announcements.
#### Scenario: Edit announcement
- **WHEN** organizer edits existing announcement
- **THEN** system updates content
- **AND** shows edit timestamp
#### Scenario: Delete announcement
- **WHEN** organizer deletes announcement
- **THEN** system removes from event
- **AND** does not notify participants of deletion
@@ -0,0 +1,38 @@
## ADDED Requirements
### Requirement: Organizer dashboard
The system SHALL provide organizers with a dashboard showing event metrics.
#### Scenario: View event statistics
- **WHEN** organizer accesses dashboard
- **THEN** system displays total events, registrations, and revenue
- **AND** shows upcoming events list
#### Scenario: View registration trends
- **WHEN** organizer views dashboard
- **THEN** system displays registration counts over time
- **AND** highlights events nearing capacity
### Requirement: Participant dashboard
The system SHALL provide participants with a dashboard of their registrations.
#### Scenario: View my registrations
- **WHEN** participant accesses dashboard
- **THEN** system displays all their registrations
- **AND** shows status for each
#### Scenario: Upcoming events
- **WHEN** participant views dashboard
- **THEN** system displays registered upcoming events
- **AND** sorts by event date
### Requirement: Quick actions
The system SHALL provide quick access to common actions from the dashboard.
#### Scenario: Organizer quick actions
- **WHEN** organizer views dashboard
- **THEN** system provides links to create event, view reports, and send announcements
#### Scenario: Participant quick actions
- **WHEN** participant views dashboard
- **THEN** system provides links to browse events and view registration history
@@ -0,0 +1,63 @@
## ADDED Requirements
### Requirement: Event categories
The system SHALL allow organizers to assign categories to events.
#### Scenario: Assign category on event creation
- **WHEN** organizer creates event with category
- **THEN** system stores category with event
- **AND** displays category on event details
#### Scenario: Assign category to existing event
- **WHEN** organizer edits event to add category
- **THEN** system updates event with category
#### Scenario: Clear category
- **WHEN** organizer removes category from event
- **THEN** system removes category from event record
### Requirement: Event tags
The system SHALL allow organizers to add multiple tags to events.
#### Scenario: Add tags on event creation
- **WHEN** organizer creates event with multiple tags
- **THEN** system stores all tags with event
- **AND** displays tags on event details
#### Scenario: Modify tags
- **WHEN** organizer edits event tags
- **THEN** system updates tags to new set
### Requirement: Category filtering
The system SHALL allow users to filter events by category.
#### Scenario: Filter by single category
- **WHEN** user filters events by specific category
- **THEN** system returns only events with that category
#### Scenario: Filter with no results
- **WHEN** user filters to category with no events
- **THEN** system returns empty list
- **AND** displays message "No events found"
### Requirement: Tag filtering
The system SHALL allow users to filter events by tags.
#### Scenario: Filter by tag
- **WHEN** user selects tag to filter
- **THEN** system returns events with that tag
#### Scenario: Multi-tag filter
- **WHEN** user selects multiple tags
- **THEN** system returns events matching ANY selected tag
### Requirement: Category management
The system SHALL provide predefined categories for organizers to choose from.
#### Scenario: List available categories
- **WHEN** organizer views category options
- **THEN** system displays predefined list (e.g., Running, Cycling, Triathlon, Trail, Road)
#### Scenario: Category selection
- **WHEN** organizer assigns category to event
- **THEN** system validates against available categories
@@ -0,0 +1,39 @@
## ADDED Requirements
### Requirement: Event creation
The system SHALL allow organizers to create new race events with required details.
#### Scenario: Create event with all details
- **WHEN** organizer provides event name, date, location, and description
- **THEN** system creates event with unique identifier
- **AND** sets event status to "draft"
#### Scenario: Missing required fields
- **WHEN** organizer attempts to create event without name
- **THEN** system returns validation error
- **AND** does not create event
### Requirement: Event editing
The system SHALL allow organizers to modify existing event details.
#### Scenario: Update event date
- **WHEN** organizer changes event date
- **THEN** system updates event date
- **AND** notifies registered participants of change
#### Scenario: Publish event
- **WHEN** organizer publishes draft event
- **THEN** system changes status to "published"
- **AND** makes event visible to participants
### Requirement: Event listing
The system SHALL display events with filtering and sorting options.
#### Scenario: List upcoming events
- **WHEN** user requests upcoming events
- **THEN** system returns events with future dates
- **AND** sorts by date ascending
#### Scenario: Filter by organizer
- **WHEN** user filters events by specific organizer
- **THEN** system returns only events created by that organizer
@@ -0,0 +1,38 @@
## ADDED Requirements
### Requirement: Payment recording
The system SHALL record payment details for event registrations.
#### Scenario: Record cash payment
- **WHEN** organizer records cash payment for registration
- **THEN** system stores payment amount, date, and method
- **AND** updates registration payment status
#### Scenario: Record online payment
- **WHEN** system receives payment confirmation from payment processor
- **THEN** system records transaction ID, amount, and timestamp
- **AND** marks registration as paid
### Requirement: Payment status tracking
The system SHALL track payment status for each registration.
#### Scenario: Unpaid registration
- **WHEN** registration has no recorded payment
- **THEN** system displays status "unpaid"
#### Scenario: Partial payment
- **WHEN** registration has payment less than required amount
- **THEN** system displays status "partial"
- **AND** shows remaining balance
#### Scenario: Fully paid
- **WHEN** registration payment equals or exceeds required amount
- **THEN** system displays status "paid"
### Requirement: Payment reporting
The system SHALL generate payment reports for organizers.
#### Scenario: Event payment summary
- **WHEN** organizer requests payment report for event
- **THEN** system displays total collected, pending, and outstanding amounts
- **AND** lists all registrations with payment status
@@ -0,0 +1,42 @@
## ADDED Requirements
### Requirement: Event registration
The system SHALL allow participants to register for published events.
#### Scenario: Successful registration
- **WHEN** participant submits registration for published event
- **THEN** system creates registration with "pending" status
- **AND** reserves participant spot
#### Scenario: Registration closed
- **WHEN** participant attempts to register for full event
- **THEN** system returns error "Event is full"
#### Scenario: Duplicate registration
- **WHEN** participant attempts to register twice for same event
- **THEN** system returns error "Already registered"
### Requirement: Registration form
The system SHALL collect required participant information during registration.
#### Scenario: Collect participant details
- **WHEN** participant registers for event
- **THEN** system collects name, email, emergency contact, and category
- **AND** stores with registration record
#### Scenario: Missing required fields
- **WHEN** participant submits incomplete form
- **THEN** system displays validation errors
- **AND** prevents submission
### Requirement: Registration status
The system SHALL track and display registration status.
#### Scenario: View registration status
- **WHEN** participant views their registrations
- **THEN** system displays status (pending, confirmed, cancelled, completed)
#### Scenario: Cancel registration
- **WHEN** participant cancels their registration
- **THEN** system updates status to "cancelled"
- **AND** releases reserved spot
@@ -0,0 +1,37 @@
## ADDED Requirements
### Requirement: User registration
The system SHALL allow new users to create accounts with email and password.
#### Scenario: Successful registration
- **WHEN** user provides valid email, password, and confirms password
- **THEN** system creates a new user account
- **AND** system sends email verification
#### Scenario: Duplicate email
- **WHEN** user attempts to register with an existing email
- **THEN** system returns error "Email already registered"
### Requirement: User login
The system SHALL authenticate users with email and password credentials.
#### Scenario: Successful login
- **WHEN** user provides correct email and password
- **THEN** system creates authenticated session
- **AND** redirects to dashboard
#### Scenario: Invalid credentials
- **WHEN** user provides incorrect password
- **THEN** system returns error "Invalid credentials"
- **AND** does not create session
### Requirement: Role-based access control
The system SHALL support organizer and participant roles with different permissions.
#### Scenario: Organizer access
- **WHEN** user with organizer role accesses event management
- **THEN** system allows full event CRUD operations
#### Scenario: Participant access
- **WHEN** user with participant role accesses event management
- **THEN** system restricts to read-only and registration only
@@ -0,0 +1,84 @@
## 1. Project Setup
- [ ] 1.1 Initialize project structure with backend and frontend directories
- [ ] 1.2 Setup .NET backend (ASP.NET Core Web API with C#)
- [ ] 1.3 Setup Next.js frontend with TypeScript using Bun runtime
- [ ] 1.4 Configure ESLint and Prettier for frontend
- [ ] 1.5 Setup Entity Framework Core with PostgreSQL
- [ ] 1.6 Create initial database schema migration (EF Core)
## 2. Database Schema
- [ ] 2.1 Create users table with roles
- [ ] 2.2 Create events table with organizer foreign key
- [ ] 2.3 Create registrations table with event and user foreign keys
- [ ] 2.4 Create payments table with registration foreign key
- [ ] 2.5 Create announcements table with event foreign key
- [ ] 2.6 Add database indexes for common queries
## 3. User Authentication (user-auth)
- [ ] 3.1 Implement user registration endpoint
- [ ] 3.2 Implement user login endpoint with JWT
- [ ] 3.3 Create authentication middleware
- [ ] 3.4 Implement role-based access control middleware
- [ ] 3.5 Create registration form component
- [ ] 3.6 Create login form component
- [ ] 3.7 Implement logout functionality
## 4. Event Management (event-management)
- [ ] 4.1 Implement create event endpoint
- [ ] 4.2 Implement update event endpoint
- [ ] 4.3 Implement list events endpoint with filtering
- [ ] 4.4 Implement get event details endpoint
- [ ] 4.5 Create event creation form component
- [ ] 4.6 Create event editing form component
- [ ] 4.7 Create event list view with filters
- [ ] 4.8 Create event detail view
## 5. Registration System (registration-system)
- [ ] 5.1 Implement registration endpoint
- [ ] 5.2 Implement registration status update endpoint
- [ ] 5.3 Implement cancel registration endpoint
- [ ] 5.4 Create registration form component
- [ ] 5.5 Create my registrations list component
- [ ] 5.6 Implement registration status display
## 6. Payment Tracking (payment-tracking)
- [ ] 6.1 Implement record payment endpoint
- [ ] 6.2 Implement payment status endpoint
- [ ] 6.3 Implement payment report endpoint
- [ ] 6.4 Create payment recording form component
- [ ] 6.5 Create payment status display component
- [ ] 6.6 Create payment report view
## 7. Announcements (announcements)
- [ ] 7.1 Implement create announcement endpoint
- [ ] 7.2 Implement edit announcement endpoint
- [ ] 7.3 Implement delete announcement endpoint
- [ ] 7.4 Implement list announcements endpoint
- [ ] 7.5 Create announcement creation form
- [ ] 7.6 Create announcement list component
- [ ] 7.7 Implement notification system
## 8. Dashboard (dashboard)
- [ ] 8.1 Implement organizer metrics endpoint
- [ ] 8.2 Implement participant registrations endpoint
- [ ] 8.3 Create organizer dashboard component
- [ ] 8.4 Create participant dashboard component
- [ ] 8.5 Add quick action buttons
## 9. Integration and Polish
- [ ] 9.1 Connect frontend to all backend endpoints
- [ ] 9.2 Add error handling and loading states
- [ ] 9.3 Implement responsive design
- [ ] 9.4 Add form validation feedback
- [ ] 9.5 Setup email service for notifications
- [ ] 9.6 Add basic unit tests for critical paths
- [ ] 9.7 Create deployment configuration
+20
View File
@@ -0,0 +1,20 @@
schema: spec-driven
# Project context (optional)
# This is shown to AI when creating artifacts.
# Add your tech stack, conventions, style guides, domain knowledge, etc.
# Example:
# context: |
# Tech stack: TypeScript, React, Node.js
# We use conventional commits
# Domain: e-commerce platform
# Per-artifact rules (optional)
# Add custom rules for specific artifacts.
# Example:
# rules:
# proposal:
# - Keep proposals under 500 words
# - Always include a "Non-goals" section
# tasks:
# - Break tasks into chunks of max 2 hours