The Midnight Riders Member Portal is a membership database for current Riders. It allows Riders to update and manage their information, and play the games that used to be housed elsewhere, attached to their Rider identity. In development, there's PayPal integration so that Riders can renew memberships and this database can be used as the Database of Record for riders information and communications, instead of Google Drive.
This project uses dotenv-rails to obscure sensitive env variables.
A .env
file is needed to run the application. You can see the format of the expected .env
file in
.env.example
in the root of the project.
The Stripe and AWS credentials are unnecessary for a large portion of the project, and all you'll really
need is the SECRET_KEY_BASE
, which can be generated for your local environment with rake secret
.
Access to the development credentials for Stripe and AWS can be obtained as needed by contacting Midnight Riders Web Committee Member @bensaufley at member-portal-support@midnightriders.com.
This repo adheres to the Scripts to Rule Them All philosophy. Scripts:
script/bootstrap
: checks for required utilities; installs as available, or
instructs user to install manuallyscript/setup
: sets up the project for local development. Builds without
cache. Runs script/bootstrap
first.script/migrate
: runs db migrations. Can be used with :up
, :down
etc:
script/migrate :down
will run bundle exec rails db:migrate:down
. If args
that don't begin with :
are passed, they'll be passed as is:
script/migrate foo bar
will run bundle exec rails foo bar
.script/update
: attempts to rebuild the docker environment, using cache, and
runs script/migrate
. Runs script/bootstrap
first.script/server
: starts the server on port 5991. Runs script/update
first.script/test
: runs the test suite. Runs script/update
first.script/console
: starts a shell session inside server
Docker service. Runs
script/update
first.script/cmd
: runs a single command inside the server
Docker service. Runs
script/update
first.For first run, run script/setup
before script/server
. In subsequent runs,
you can just run script/server
.
postgresql
is used for the database. I've used
Postgres.app for Mac,
which is pretty plug-and-play. You'll need a root
user with broad privileges.
phantomjs
is also required to run spec, and can also be installed using Homebrew:
brew install phantomjs
.
Other dependencies are outlined in the Gemfile.
This repo is open to contribution by anyone interested in lending a hand. Simply fork the repo and, when ready, submit a Pull Request. Make sure RSpec passes before submitting, and any new functionality is covered by tests. In your PR, explain your changes and post screenshots if there's anything relevant to show.
Linter configurations will become a part of this project soon, but in the meantime, please adhere to the de facto conventions of the repo and mimick the styles you see. For example: single quotes except for interpolation, JSON-style hashes, etc.
Ability
Club
Match
Membership
MotM
PickEm
Player
RevGuess
User
Setup for CanCanCan, Permission
-based permissions.
The model for clubs or teams. Has many Matches
, Players
. Has home_matches
and away_matches
which are both incarnations of Match
. The .matches
method returns all Matches
that include
the club as either home or away.
Attributes:
Name | Type | Attributes |
---|---|---|
id |
integer |
not null, primary key |
name |
string(255) |
|
conference |
string(255) |
|
primary_color |
integer |
|
secondary_color |
integer |
|
accent_color |
integer |
|
abbrv |
string(255) |
|
created_at |
datetime |
|
updated_at |
datetime |
|
crest_file_name |
string(255) |
|
crest_content_type |
string(255) |
|
crest_file_size |
integer |
|
crest_updated_at |
datetime |
The model for matches or games. Has many MotMs
, RevGuesses
, PickEms
. Has a home_team
,
and an away_team
. Both are Club
instances. Same model, same table. uid
is pulled from
the calendar import (see matches_controller#import
).
Attributes:
Name | Type | Attributes |
---|---|---|
id |
integer |
not null, primary key |
home_team_id |
integer |
|
away_team_id |
integer |
|
kickoff |
datetime |
|
location |
string(255) |
|
home_goals |
integer |
|
away_goals |
integer |
|
created_at |
datetime |
|
updated_at |
datetime |
|
uid |
string(255) |
|
season |
integer |
One Membership
per User
, per year. Single-table inheritance for type
s:
Individual
, Family
, Relative
. Family
has_many :relatives
; Relative
belongs_to
Family
(through family_id
)
Attributes:
Name | Type | Attributes |
---|---|---|
id |
integer |
not null, primary key |
user_id |
integer |
|
year |
integer |
|
info |
hstore |
|
created_at |
datetime |
|
updated_at |
datetime |
|
privileges |
json |
|
type |
string(255) |
For STI |
family_id |
integer |
Only for Relative subclass |
refunded |
text |
Can be true, nil, or contain comment or Stripe code |
Man of the Match model. Up to three picks - no duplicates, only Players
who are active?
.
Only voteable between 45 minutes and two weeks after kickoff.
Attributes:
Name | Type | Attributes |
---|---|---|
id |
integer |
not null, primary key |
user_id |
integer |
|
match_id |
integer |
|
first_id |
integer |
|
second_id |
integer |
|
third_id |
integer |
|
created_at |
datetime |
|
updated_at |
datetime |
Pick 'Em model. Users can pick either team, or a draw, for every Match
. One point for correct
picks. Only voteable up until kickoff, of course. One pick per user per match.
Attributes:
Name | Type | Attributes |
---|---|---|
id |
integer |
not null, primary key |
match_id |
integer |
|
user_id |
integer |
|
result |
integer |
|
created_at |
datetime |
|
updated_at |
datetime |
|
correct |
boolean |
Just what it says. Belongs to Club
.
Attributes:
Name | Type | Attributes |
---|---|---|
id |
integer |
not null, primary key |
first_name |
string(255) |
|
last_name |
string(255) |
|
club_id |
integer |
|
position |
string(255) |
|
created_at |
datetime |
|
updated_at |
datetime |
|
number |
integer |
|
active |
boolean |
default(TRUE) |
Score predictions for Revs games. One per user per Match
.
Attributes:
Name | Type | Attributes |
---|---|---|
id |
integer |
not null, primary key |
match_id |
integer |
|
user_id |
integer |
|
home_goals |
integer |
|
away_goals |
integer |
|
comment |
string(255) |
|
created_at |
datetime |
|
updated_at |
datetime |
|
score |
integer |
Devise-based model for users.
Attributes:
Name | Type | Attributes |
---|---|---|
id |
integer |
not null, primary key |
last_name |
string(255) |
|
first_name |
string(255) |
|
address |
string(255) |
|
city |
string(255) |
|
state |
string(255) |
|
postal_code |
string(255) |
|
phone |
integer |
|
email |
string(255) |
default(""), not null |
username |
string(255) |
default(""), not null |
member_since |
integer |
|
created_at |
datetime |
|
updated_at |
datetime |
|
encrypted_password |
string(255) |
default(""), not null |
reset_password_token |
string(255) |
|
reset_password_sent_at |
datetime |
|
remember_created_at |
datetime |
|
sign_in_count |
integer |
default(0), not null |
current_sign_in_at |
datetime |
|
last_sign_in_at |
datetime |
|
current_sign_in_ip |
string(255) |
|
last_sign_in_ip |
string(255) |
|
stripe_customer_token |
string(255) |
|
country |
string(255) |