Please read these points before getting started:
- Please always make a separate branch if you are building or updating something
- When updating (invoking and retrieveing) something related to the schema or database does not work with NUS Wifi (Firewall against MongoDB)
- Please also note that if you add or change the prisma schema, always remember to do "npx prisma generate" to have it reflect on your local development, if not it will show errors
- Before pushing it is also important for you to run "npm run format" and "npm run build"
Clone the project to your designated folder with git clone
Make sure you install the dependencies when you clone the project for the first time. Use whichever command below corresponding to your favourite package manager:
npm install
# or
yarn install
# or
pnpm install
# or
bun install
Create a .env
file in the root directory (same location as the package.json
file) to include the environment variables needed for the server to work properly.
# Mongo Atlas
DATABASE_URL=
# NextAuth
NEXTAUTH_URL=
NEXTAUTH_SECRET=
# Github Authentication
GITHUB_ID=
GITHUB_SECRET=
# Google Authentication
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
# Cloudinary
CLOUD_NAME=
CDN_API_SECRET=
CDN_API_KEY=
before we run the environment please run
npx prisma generate
then, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying app/page.tsx
. The page auto-updates as you edit the file.
This project uses next/font
to automatically optimize and load Inter, a custom Google Font.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!