README
This is the repository for the Rattlesnake Ramble website, hosted at https://www.rattlesnakeramble.org.
Local setup requires the following:
- Ruby version: 3.2.5
- Rails version: 6.1
- Postgres 11 (16 is the latest version)
The actual versions used in this project can be seen in the Gemfile and the .ruby-version file.
This project uses rbenv to manage Ruby versions. If you don't have rbenv installed, you can install it with Homebrew:
brew install rbenvThe version for the project is specified in the .ruby-version file of this project. To install the correct Ruby
version, run:
rbenv installThen, make sure to initialize rbenv in your shell:
rbenv initAlso, put this in your .zshrc:
eval "$(rbenv init - zsh)"Database creation
- Install Postgres if you don't have it already:
Using Homebrew on MacOS
$ brew install postgresql@16
Follow the instructions for automatically starting postgres when you start your machine.
- Database initialization
$ bundle exec rails db:reset
- How to run the test suite
$ bundle exec rspec
Deployment instruction
Installing the Heroku CLI
Go here to install the CLI.
Once you have it installed (or to check that you have it installed), do this:
heroku --versionNow login:
heroku loginIn order to push to heroku, you need to have added heroku as a remote repository. You can check if this has been added by running:
git remote show herokuIf it doesn't exist, add it with the heroku CLI:
heroku git:remote -a rattlesnake-rambleOnce your local master is up to date and you have Heroku CLI credentials in place, run the following command:
$ git push heroku master
Models
Racers
- first_name (required)
- last_name (required)
- email (required)
- birth_date (required)
- gender (required)
- city
- state
Races
- name (required)
- description
- location
- editions
Race Editions
- race (required)
- date (required)
- entry_fee (required)
- default_start_time_male (required)
- default_start_time_female (required)
- accepting_entries
- entries
Race Entry
- racer (required)
- race_edition (required)
- time (filled in after finishing race)
- paid? (defaults to false and set to true with confirmation of payment)
Products
- description (required)
- quantity (required)
- price (required)
- images (optional series of images to show the product)
Race Categories
- name
- gender
- minimum_age
- maximum_age
Examples:
| Category Name | Gender | Min Age | Max Age |
|---|---|---|---|
| Under 20 Male | :male | 0 | 20 |
| 20-29 Male | :male | 20 | 29 |
| 60+ Female | :female | 60 | 200 |
| 50-59 Female | :female | 50 | 59 |
Race Placement Package
- name
- num_overall_finishers_to_remove_from_categories (defaults to 3)
- num_masters_finishers_to_remove_from_categories (defaults to 3)
- starting_masters_age (defaults to 40)
- categories
Examples:
| Race Edition | Overall Finishers to Remove | Masters Finishers to Remove | Starting Masters' Age |
|---|---|---|---|
| Rattlesnake Ramble Long Course | 3 | 3 | 40 |
| Rattlesnake Ramble Kids Course | 0 | 0 | 40 |
Placement Test:
Given the following results:
| Name | Age | Gender | Seconds |
|---|---|---|---|
| Joe Smith | 35 | Male | 1750 |
| Jim Smith | 41 | Male | 2000 |
| Sue Smith | 25 | Female | 2100 |
| Pam Smith | 33 | Female | 2250 |
| Bob Smith | 51 | Male | 2500 |
| Sal Smith | 42 | Male | 1950 |
| Cal Smith | 21 | Male | 1800 |
| Sam Smith | 32 | Male | 1900 |
Useful Aliases
alias gs='git status'
alias gp='git push'
alias gpr='git push heroku master'
alias test='rake test'
alias resetdb='rake db:reset'
alias rebuilddb='rake db:schema:load'
alias start='rails server -b $IP -p $PORT'
alias pushToHeroku='git push heroku master'Useful things
I use rvm to manage my ruby versions. To install a new version do this:
rvm install 3.0.4I had trouble with rvm and then used rbenv with some luck. Until Heroku started complaining about the version of Ruby I was using (3.2.4) and rbenv didn't even list that version (maxed at 3.2.4) and only went to 3.3.1 (Heroku supports 3.3.5), but still couldn't install rvm, so then did:
> brew install install-rubyThis ran for a long time, but eventually installed Ruby 3.2.5.
If you need to mess with the database (not recommended, as we prefer admin pages on the site), you can do so via the Heroku console. Once there you can run the Rails Console
heroku run consoleThen you can select Active Record models, modify them, and commit them to the database like this:
latest = RaceEdition.find_by(:date => '2022-09-10')
latest.date = Date.new(2022, 9, 17)
latest.default_start_time_female = Time.zone.parse('2022-09-17 13:52:00')
latest.saveTo see all the routes that this application supports, run:
rails routesIt shows something like this:
Prefix Verb URI Pattern Controller#Action
root GET / pages#home
welcome_index GET /welcome/index(.:format) welcome#index
home GET /home(.:format) pages#home
enter GET /enter(.:format) pages#enter
thanks GET /thanks(.:format) pages#thanks
charity GET /charity(.:format) pages#charity
race_reports GET /race_reports(.:format) pages#race_reports
new_user_session GET /users/sign_in(.:format) devise/sessions#new
user_session POST /users/sign_in(.:format) devise/sessions#create
destroy_user_session DELETE /users/sign_out(.:format) devise/sessions#destroy
races GET /races(.:format) races#index
POST /races(.:format) races#create
new_race GET /races/new(.:format) races#new
edit_race GET /races/:id/edit(.:format) races#edit
race GET /races/:id(.:format) races#show
PATCH /races/:id(.:format) races#update
PUT /races/:id(.:format) races#update
DELETE /races/:id(.:format) races#destroy
racers GET /racers(.:format) racers#index
POST /racers(.:format) racers#create
new_racer GET /racers/new(.:format) racers#new
edit_racer GET /racers/:id/edit(.:format) racers#edit
racer GET /racers/:id(.:format) racers#show
PATCH /racers/:id(.:format) racers#update
PUT /racers/:id(.:format) racers#update
DELETE /racers/:id(.:format) racers#destroy
enter_race_edition GET /race_editions/:id/enter(.:format) race_editions#enter
create_entry_race_edition POST /race_editions/:id/create_entry(.:format) race_editions#create_entry
racer_emails_race_edition GET /race_editions/:id/racer_emails(.:format) race_editions#racer_emails
racer_info_csv_race_edition GET /race_editions/:id/racer_info_csv(.:format) race_editions#racer_info_csv
race_entries_race_edition GET /race_editions/:id/race_entries(.:format) race_editions#race_entries
race_editions POST /race_editions(.:format) race_editions#create
new_race_edition GET /race_editions/new(.:format) race_editions#new
edit_race_edition GET /race_editions/:id/edit(.:format) race_editions#edit
race_edition GET /race_editions/:id(.:format) race_editions#show
PATCH /race_editions/:id(.:format) race_editions#update
PUT /race_editions/:id(.:format) race_editions#update
DELETE /race_editions/:id(.:format) race_editions#destroy
successful_entry_race_entry GET /race_entries/:id/successful_entry(.:format) race_entries#successful_entry
cancelled_payment_race_entry GET /race_entries/:id/cancelled_payment(.:format) race_entries#cancelled_payment
edit_race_entry GET /race_entries/:id/edit(.:format) race_entries#edit
race_entry PATCH /race_entries/:id(.:format) race_entries#update
PUT /race_entries/:id(.:format) race_entries#update
DELETE /race_entries/:id(.:format) race_entries#destroy
products GET /products(.:format) products#index
POST /products(.:format) products#create
new_product GET /products/new(.:format) products#new
edit_product GET /products/:id/edit(.:format) products#edit
product GET /products/:id(.:format) products#show
PATCH /products/:id(.:format) products#update
PUT /products/:id(.:format) products#update
DELETE /products/:id(.:format) products#destroy
rails_service_blob GET /rails/active_storage/blobs/:signed_id/*filename(.:format) active_storage/blobs#show
rails_blob_representation GET /rails/active_storage/representations/:signed_blob_id/:variation_key/*filename(.:format) active_storage/representations#show
rails_disk_service GET /rails/active_storage/disk/:encoded_key/*filename(.:format) active_storage/disk#show
update_rails_disk_service PUT /rails/active_storage/disk/:encoded_token(.:format) active_storage/disk#update
rails_direct_uploads POST /rails/active_storage/direct_uploads(.:format) active_storage/direct_uploads#createCreating a new race edition
You create a new race edition, do the following:
-
From the Admin menu, select "Races" (or just go here)
-
Click on the race for which you want to make a new edition
-
Enter the date and default start times for men and women
Updating entries
Getting racer emails, unpaid racer emails
From the Admin menu, select "View Full Course Emails" or "View Kids Course Emails"
On this page there are three buttons: All, Paid, Unpaid
Updating payment and bib number for entrants
http://www.rattlesnakeramble.org/race_entries
Make sure to find the entry for the correct race editions
Updating racer information, like birth date
http://www.rattlesnakeramble.org/racers
Exporting racer information to a spreadsheet
Posting race entries to OpenSplitTime.org
- Set up the event group in OpenSplitTime.org
- Make a new rake task for the specific year. There are several examples in
lib/tasks/ost/post_entries.rake - Run the rake task, then ensure the race entries appear within the new event group in OpenSplitTime.org.
Features
Optional Merchandise (mostly shirts) Vending
Upon signing up for the race, if the current race edition is selling a product, then an image of the product should be displayed, a text description of the product should be displayed and a dropdown should be displayed with options the user should be displayed ('Female Small', 'Male Medium', etc.), and the price should be displayed. If the product is selected, then the price of the product is added to the PayPal total and the sale is recorded in the Sales table.
The Sales table should reference the product, specify the option, the date purchased, and the racer purchasing the product.