How To: Develop the Website

!! This page is a work in progress!!

Prerequisites

There are a few things that you'll need to run the website locally.

1. NodeJS (^v20.xx.xx, recommend to install via nvm or nvs)
2. PNPM (^v8.15.7, install via npm i -g pnpm, pnpm.io)
3. A PostgreSQL Database (Free from DigitalOcean using your GitHub Students Developer Pack, or run locally via the included docker-compose file)
   If you don't know what a docker-compose is, you should use the DigitalOcean offering.
4. Discord Oauth Credentials (Follow the instructions below: #How to get Discord OAuth Credentials)
5. Google Oauth Credentials (Guide from Google)

How to get Discord OAuth Credentials

There are no good guides, so here's one from brilliantdeviation7: message permalink on discord

1. Go to the Discord Developer Portal
2. Create a new application
3. Go to the OAuth2 page
4. Press reset client secret and copy the value
5. Copy the client id

Onboarding

Something important to note: All development will be done on forks, regardless of whether or not you are a maintainer. Please make sure you keep your fork up-to-date with the latest commit on the upstream (this) repository each time before you begin development. This is very important.

Once you've obtained all of the prerequisites above, you can continue with the following instructions.

1. Create a fork of this repository (find the fork button on this page and click it).
   Here's a guide on how to fork a repository on GitHub.
2. Clone the forked repository and enter it with your code editor.
3. Create and populate your .env file (see the .env.example file for a template)
   Git will automatically ignore this file and not upload it to GitHub, so it is safe to store secrets.
   Please DO NOT share any secrets you generate for this project. If someone asks you for credentials for this project, direct them to this page.
4. Run pnpm install.
5. Run pnpm dev.
6. Profit.

If you need help, please contact a website co-lead or frontend co-lead on Discord for assistance.