Skip to content

Commit 7ce31ff

Browse files
committed
Update documentation with product changes
1 parent 46bdc9f commit 7ce31ff

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

CLAUDE.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
55
## Development Commands
66

77
### Basic Rails Commands
8-
- `bin/dev` - Start the Rails development server and Tailwind watch process
8+
- `bin/dev` - Start the Rails development server and Tailwind watch process (not normally required, the user runs the server constantly)
99
- `bin/rails console` - Open Rails console for debugging
1010
- `bin/rails generate` - Generate Rails components (models, controllers, migrations)
1111
- `bin/rails db:migrate` - Run database migrations
@@ -23,24 +23,27 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
2323
- `bin/rubocop` - Run Ruby style linter (uses rubocop-rails-omakase)
2424

2525
### Deployment (Kamal)
26+
Let the user handle deployment, but here are the commands you might need to suggest to them.
27+
2628
- `kamal setup` - Initial deployment setup
2729
- `kamal deploy` - Deploy application
2830
- `kamal console` - Access production Rails console
2931
- `kamal shell` - SSH into production container
3032
- `kamal logs` - View production logs
3133

32-
Note: Deployment requires `KAMAL_REGISTRY_PASSWORD` environment variable and SSH access to server specified in `config/deploy.yml`.
33-
3434
## Application Architecture
3535

36-
This is a Rails 8.x application for managing running events with user registration and results tracking.
36+
This is a Rails 8.1 application for managing running events with user registration and results tracking.
3737

3838
### Core Models
39-
- **Event** (`app/models/event.rb`) - Central entity representing running events with date, location, and number. Manages finish positions, times, and results.
39+
- **Event** (`app/models/event.rb`) - Central entity representing running events with date and number. Belongs to a Location. Manages finish positions, times, and results.
4040
- **User** (`app/models/user.rb`) - Handles authentication and user management with email confirmation.
4141
- **Result** (`app/models/result.rb`) - Links users to events with optional completion times.
4242
- **FinishPosition** / **FinishTime** - Track event completion data.
4343
- **Volunteer** / **Role** / **Assignment** - Manage event staffing.
44+
- **Location** (`app/models/location.rb`) - Manages event locations/courses with route details, maps, facilities, and Strava integration.
45+
- **Badge** / **UserBadge** - Achievement badge system with levels (bronze, silver, gold, singular) tracking user milestones.
46+
- **CheckIn** (`app/models/check_in.rb`) - Token-based event check-in system for tracking participant attendance.
4447

4548
### Authentication
4649
Uses a custom authentication system (`app/controllers/concerns/authentication.rb`) with session-based login. No external auth gems like Devise.
@@ -86,7 +89,7 @@ All controllers inherit from `ApplicationController` which includes `Authenticat
8689
Models follow standard Rails patterns with Active Record. The `Event` model contains the main business logic for result notifications and user management.
8790

8891
### Email System
89-
Event-related emails are triggered automatically when `results_ready` is set to true on an Event. Uses Action Mailer with deliver_later for background processing.
92+
Event-related emails are triggered automatically when an event's status changes to `finalised`. Uses Action Mailer with deliver_later for background processing.
9093

9194
### Admin Features
9295
Admin functionality is separated into `app/controllers/admin/` namespace with `AdminAuthentication` concern for access control.

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WS10: Website and admin for Western Sydney 10 running events
22

3-
A Rails 8.0 application for managing running events with user registration, results tracking, and comprehensive admin tools.
3+
A Rails 8.1 application for managing running events with user registration, results tracking, and comprehensive admin tools.
44

55
## Features
66

@@ -16,7 +16,7 @@ A Rails 8.0 application for managing running events with user registration, resu
1616

1717
### Tech Stack
1818

19-
- **Backend**: Rails 8.0 with Ruby 3.3.4
19+
- **Backend**: Rails 8.1 with Ruby 3.3.4
2020
- **Database**: SQLite (all environments)
2121
- **Frontend**: Stimulus, Turbo, Tailwind CSS, Importmap
2222
- **Background Jobs**: Solid Queue (runs in Puma process via `SOLID_QUEUE_IN_PUMA`)
@@ -26,11 +26,14 @@ A Rails 8.0 application for managing running events with user registration, resu
2626

2727
### Core Models
2828

29-
- **Event** - Central entity representing running events with date, location, and number. Manages finish positions, times, and results
29+
- **Event** - Central entity representing running events with date and number. Belongs to a Location. Manages finish positions, times, and results
3030
- **User** - Handles authentication and user management with email confirmation. Links to results and volunteer assignments
3131
- **Result** - Links users to events with optional completion times and finish positions
3232
- **FinishPosition** / **FinishTime** - Track event completion data separately for flexible result management
3333
- **Volunteer** / **Role** / **Assignment** - Manage event staffing and user permissions (Administrator, Organiser)
34+
- **Location** - Manages event locations with course details, maps, facilities, and route information
35+
- **Badge** / **UserBadge** - Achievement badge system with levels (bronze, silver, gold, singular) tracking user milestones
36+
- **CheckIn** - Token-based event check-in system for tracking participant attendance
3437

3538
### Key Features
3639

0 commit comments

Comments
 (0)