Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 1.87 KB

README.md

File metadata and controls

68 lines (47 loc) · 1.87 KB

Students Inferno

studentsInferno

Study companion app designed to help students find others to form study groups with. This platform combines the convenience of a dating app with the purpose of finding like-minded individuals.

Table of Contents

Features

  • Find Likeminded Individuals - Find other students with the same major, year, and classes as you are with our matchfinding system.
  • Create/Find Study Groups - Our app allows you to create a study group with the people you have matched with. If you don't want to create one, you can also find a list of study groups already created and join from there.
  • Message Your Study Buddies - To contact your matches or your study group, our app provides a messaging system. Whether you want to invite them to a study group, introduce yourself, or plan a time to meet, the possibitilies are endless.

Getting Started

  1. After cloning the repository, if it doesn't already exist, create a ".env.local" file in the root directory.

  2. Copy and paste the API keys sent to your email from Hieu Duong into this file as shown below.

  3. Install dependencies:

npm install
  1. Run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
  1. Open http://localhost:3000 with your browser to see the result.

Tech Stack

  • React
  • NextJS
  • MongoDB Atlas
  • Express

Libraries

  • next-auth
  • mongoose
  • react-select
  • react-icons

Contributors

Hieu Duong - Kevin-D23

Britney Chen - Britney Chen

Michael Khojastegan - mkhojastegan

Haohan Chen - Tangerine-maker

Amanda Mai - moomoonda