Overview

This project uses

• Next.js
• Tailwind CSS
• tRPC
• Auth.js
• Drizzle ORM

Setting Up

Once you have cloned the repository locally, run

npm install

to download all necessary packages.

---

If it is your first time setting up, create a .env file in the root directory and copy-paste the .env.example file's contents into .env

Ask the IT directors to give you the values for the environment variables. NEVER commit or push the .env file.

---

Ensure that you have Prettier (VSCode extension or other) installed to lint your code before you commit + push.

Getting Started

To run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

---

For faster compilation times (but possibly buggy behaviour), you can use:

npm run turbo

---

To run drizzle-studio (i.e., to interact directly with the MySQL database)

npm run drizzle

Open https://local.drizzle.studio with your browser.

---

To update the db schema, edit the schema.ts file and run

npx drizzle-kit generate:sqlite

to generate the relevant SQL migration in ./db/

After checking the migration is appropriate, you can then use

turso db shell elixir

and .read to update the elixir database schema.

Contributors

2024: Aditya Muthukattu, Josh Lim

2023: Prayag Rawat, Adrian Lim, Wanning Cai, Lucas Sutherland, Dulini Galhena, Josh Lim