- Install and get Docker running on your local machine (I suggest using Docker Desktop)
- You will need to install WSL2 for Windows machines
- Start a local instance of PostgreSQL using Docker
- You can run a simple setup by running
docker run --name postgres -p 5432:5432 -e POSTGRES_PASSWORD=password -d postgres
in a terminal that has Docker POSTGRES_PASSWORD
will be used elsewhere and is required.
- You can run a simple setup by running
You will need to set up a simple config file (.env.local
) in the root of the project. This should not be pushed to the codebase and is ignored by .gitignore
already.
Add the following key-value pairs using your own auth values:
(anything prefixed with *
is optional)
DATABASE_URL
- The PostgreSQL connection string.
DISCORD_CLIENT_ID
- Client ID for authentication.
DISCORD_CLIENT_SECRET
- Client Secret for authentication.
*
DISCORD_CALLBACK_URL
- The callback URL for where the user should be redirected back to the site (this has a default in .env
and shouldn't be changed)
*
GOOGLE_CLIENT_ID
- Client ID for authentication.
*
GOOGLE_CLIENT_SECRET
- Client Secret for authentication.
*
GOOGLE_CALLBACK_URL
- The callback URL for where the user should be redirected back to the site (this has a default in .env
and shouldn't be changed)
*
TWITTER_CONSUMER_KEY
- Consumer key for authentication.
*
TWITTER_CONSUMER_SECRET
- Consumer secret for authentication.
*
TWITTER_CALLBACK_URL
- The callback URL for where the user should be redirected back to the site (this has a default in .env
and shouldn't be changed)
CDN_ACCOUNT_ID
- The CDN account ID for the Cloudflare CDN.
CDN_API_KEY
- The CDN API key for the Cloudflare CDN.