This website was created in order to connect students studying similar courses and facilitate collaborative study sessions while fostering a supportive learning community. By providing a platform for users to find peers studying the same subjects, our goal was to enhance study efficiency, encourage knowledge sharing, and promote academic success.
With our platform, you'll be able to easily connect with peers and classmates studying in Marston to enhance both of your study sessions and improve your academic performance. Say goodbye to solo study sessions and hello to collaborative learning opportunities, tailored to your course needs.
Tools: Next.js, Docker, Flask, SQLAlchemy, NextUI, TailWindCSS, React You will need to have Python and JavaScript installed. But a decent majority of this will be automatically installed when the Requirements.txt is ran with the build.
- Download Docker and Node.js
- Run Docker build and Docker run in order for the Backend to run
- Run the command in the Frontend file 'npm run dev'
- If no Frontend page pops up, type in the URL 'localhost:3000'
- You’ll begin by creating a username and password. After that, you will see a layout of a Marston of your choosing.
- You can then hover your mouse over the map, and then select the location on the map where you are going to study.
- Click the desired location and a red dot will appear asking for a course _. Make sure what you enter is the courses code!!! Or something less than or equal to 8 characters (so you can say something like MCAT too).
- Your study session has started! Now others can see where and what you are studying, and choose to join your session too.
- Exiting out of the website will end all of the study sessions.
- Start time: you can see the time a study group was initially created and be in awe of how long they’ve been studying
- Members: when you click on an active study session, you can see a list of the members who have joined that session.
This was everyone in the team's first hackathon, so we ran into a lot of problems both technically and as a programming team. But hopefully we'll be able to do work together in the future to improve it and launch it as an actual website for students to use. Here's a little rundown of what we'd change:
- Resolve all the issues with our current implementation.
- Finish developing the Active User tab that will display all of the Users currently studying on a selected floor.
- Add the option to leave the study group, rather than leaving when the browser is closed. This would remove that user from the Study Session's Members list, and once that list is empty, the Study Session will end on its own.
- Include Library West as an option.
- Improve the UI/UX.
This is a Next.js project bootstrapped with
create-next-app
.
First, 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.js
. 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!
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.