Skip to content

Latest commit

 

History

History
executable file
·
144 lines (85 loc) · 4.73 KB

README.md

File metadata and controls

executable file
·
144 lines (85 loc) · 4.73 KB
Raw

Simple Office Hours Queue

What?

SOHQ is an open-source office hours queue that allows students to sign up for office hours and instructors to manage the queue.

For a brief usage guide, click here.

Installation

Prerequisites

  • Node.js >= 18.17

Clone the reposity and cd into it.

For the .env setup, Refer to the .env.example file for the format of the required environment variables. The setup is as follows:

Run cp .env.example .env to create the .env file.

Ably

Ably is used for real-time communication (i.e. queue updates)

  1. Create an account on Ably.

  2. Create a new app.

  3. Go to the "API Keys" tab. You should have 2 API keys, one for the server (top) and one for the client (bottom). Copy the server API key and paste it into the ABLY_SERVER_API_KEY variable in the .env file. Copy the client API key and paste it into the NEXT_PUBLIC_ABLY_CLIENT_API_KEY variable in the .env file. Your client API key should have the Subscribe and Publish permission enabled. Ably API Keys

Google OAuth

Google OAuth is used for authentication.

  1. Create a new project on Google Cloud Platform.

  2. Navigate to the Credentials tab. Press the "Create Credentials" button and select "OAuth client ID". Go throuth the process of filling out the form. Select External if you're given the option. Press the "Create Credentials" button again. This time select "Web application" as the application type.

  3. Create a new OAuth client ID. Make sure to set the Authorized JavaScript origins to http://localhost and redirect URI to http://localhost:3000/api/auth/callback/google. When deployed, add new entries, replacing localhost/localhost:3000 to the new URL. Google Auth setup

  4. Copy the client ID and paste it into the GOOGLE_CLIENT_ID variable in the .env file.

  5. Copy the client secret and paste it into the GOOGLE_CLIENT_SECRET variable in the .env file.

Database

Local Development

For local development we run a docker container serving a mySQL database.

  1. Install Docker on your machine.

  2. Start the container by running:

docker compose up

Note that if you are using an M1 Mac, you may need to change the docker image in docker-compose.yaml to 'arm64v8/mysql'. This is because the official image for MySQl, as of writing, does not currently support the ARM architecture.

Production

For the production environment, you can self-host a database or consider a hosted provider such as Planetscale, Aiven, AWS RDS, etc.

  1. Create a new database on your platform.

  2. Copy the database URL and paste it into the DATABASE_URL variable in the .env file.

NextAuth

Run openssl rand -base64 32 (you may need to download openssl) and put the result inside of NEXTAUTH_SECRET.


After your .env file is set up, run the following commands to install dependencies populate the database with the schema:

npm install
npx prisma db push

We need to populate the database with the default settings and first user. Go to prisma/seed.ts and change the YOUR_EMAIL_ADDRESS variable to your email. Then run:

npx prisma db seed

If you want to run the server in development mode (to see live changes), run the following command:

npm run dev

If you want to create a production build, run the following commands:

npm run build
npm run start

If you'd like to view or edit your database locally at any point, you can run

npx prisma studio

Tech Stack

This project is built using the T3 stack, specifically these aspects:

Contributing

If you'd like to contribute, please make a pull request. If you have any questions, feel free to open an issue.

To run the Biome formatter/linter:

npm run fmt

Powered by Vercel