X Factor League
X Factor League provides a space to create fantasy leagues for reality game shows. Currently, we support Amazing Race and Big Brother, with Survivor being in the works. The site runs on NextJS, React, and Redis, reading data from the relevant Wikipedia pages.
Table of Contents
- Getting Started
- Commands
- Seeding the Database
- Operational Notes
- Using The Site
Getting Started
We have two key phrases that we use throughout the app:
- Competing Entity: This is used for any competitor (individual or teams) in a show
- Contestant: This is used for any competitor in a league
This app requires setting a local environment variable. Here's how to set up this variable:
- Generate a local secret key. One way to do this is to run
openssl rand -base64 32
- In your
.env.development.local, create a variable named SESSION_SECRET
- Set this variable equal to the value you generated in step 1.
- Stop and start your app.
In order to test or develop on the backup cron you will need the following variables set:
CRON_SECRET=<can be anything when running locally>
AWS_ROLE_ARN=<ask @jjm3x3>
AWS_REGION="us-east-2"
S3_BUCKET_NAME="league-data-nonprod-backup"
Commands
npm run dev: Runs the development server. The development URL is http://localhost:3000.npm run seed:dev: Seeds the Redis development database. You will need development credentials. Ask [@jjm3x3] (https://github.com/jjm3x3) for help. Read seeding the db for more information.npm run seed:prod: Seeds the Redis production database. You will need production credentials. Ask [@jjm3x3] (https://github.com/jjm3x3) for help. Read seeding the db for more information.npm run test: Runs the unit tests for the app. These tests are written in Jest.npm run lint: Runs our linter, built in ESLint. If you want to autofix the problems, run npm run lint:fix.
Seeding The DB
Since we do not have authentication or authorization on the site for now, all data stored in the backend has been stored in source
see leagueData and in our database. We have created two
new npm stages under the "scripts" section of package.json. They are seed:dev
and seed:prod, which will run the seedDb script.
How to run
- Put secrets in appropriate
.env* file.
- If you are authenticated to Vercel and have the vercel CLI installed
- Run
vercel env pull in order to setup the build.
- Run
vercel env pull .env.development.local in order to setup to run the seed:dev command.
- Run
vercel env pull --environment production .env.production.local in order to setup to run the seed:prod command.
- If you are not authenticated
- Get in touch with @jjm3x3 in order to arrange some credential exchange
- Run either
seed:dev or seed:prod depending which you need.
- These have different credentials. Make sure you have the appropriate ones.
- Make sure you seed prod before you deploy updated code to prod.
Operational Notes
This is a small section to get some ideas about how the site may be configured to work.
Backup
We have setup a 3rd tier "off-site" backup where we write all our key/value pairs to an S3 bucket. This process runs every day at 3pm UTC (7am PST)
note: this only backs up key/value pairs which have json values, it skips the rest.
Config
- Wikipedia calls are configured to cache for 3600s (or 1h)
Day Overrides
Sometimes Wikipedia lists exits in separate placements even though they really happened in the same round, such as two
separate tribal councils on the same day. A day override puts everyone who left on a given day into the same round. For
now these can only be set by hand in a league's configuration, so if you are a "Show Admin" and feel a day override
should be added for a round, contact @jjm3x3 with:
- The override, in this format, listing every day that should be a single round:
"parserOptions": { "dayOverrides": [11, 13] }
- A justification for the override, e.g. which contestants left on that day and why they should leave in the same round.
note: day overrides are only supported for Survivor leagues today. See the
Survivor parser spec for exactly how they are applied.
Using The Site
Normal Usage
Any user can navigate to our various read-only pages.
Create A League
If you are a user who would like to create a league, first you need to have an account.
How To
- Create an account by going to our Create Account Page.
- Let @jjm3x3 know, and he can get you set up.
- Navigate to the League Creation Page, fill out the form, and hit submit
