Competl

Competl is a Next.js project built by Group 10, Oscar Wong, Jan Jelinek, Michael Jeremy Olea, and Antonio Santos.

The code is hosted on GitHub at https://github.com/oscarwong67/Competl.

Getting Started

First, ensure you have Node.js and npm.

Optionally, you can also get the global package, pnpm, which makes node_modules smaller via hard-linking.

First, from the project root (Somewhere/On/Your/Computer/Competl/) install dependencies:

npm install
# or, if you want a smaller node_modules size
pnpm install
# more info: https://pnpm.io/installation

Next, make sure you have the .env.development file included in the ZIP folder submitted on D2L. This file is NOT included in the public GitHub repository, as that is bad security practice (and GitHub is currently rolling out automatic secret detection to prevent secrets from ever being pushed).

The entries in it should look like the following:

# env example

vNEXTAUTH_URL=
NEXTAUTH_SECRET=

# the following entries are REQUIRED to sign in and connect to the db

GOOGLE_ID=
GOOGLE_SECRET=

GITHUB_ID=
GITHUB_SECRET=

MONGODB_URI=

Make sure it's named .env.development - the dot at the beginning is important!

Next, run the development server:

npm run dev
# or
pnpm run dev

Open http://localhost:3000 with your browser to see the result, once the above server is finished compiling.