Skip to content

Latest commit

 

History

History
167 lines (110 loc) · 7.07 KB

Code_of_duty.md

File metadata and controls

167 lines (110 loc) · 7.07 KB


StudyNex

StudyNex - A next generation virtual group study platform
CoC Inheritance 2023 || Code Of Duty


Table of Contents

📝Description

General Description:-

StudyNex....as the name suggests is the next generation virtual group study platform designed for the students by the students. It involved many entities such as student's particular organization, teachers & students of that organization etc. Using this web platform organizations can improve their overall flow of learning. All the students & teachers of the organizations can have a insightful communication through interactive channels where teachers can upload study documents, arrange assessments for the students. Also if a group of students wants to study only in their anonymous group then they can create their own private channels where they can interact.

Workflow:-

Organization should register themselves. Separate general channel will be created for each organization. Then admin can share organization invite code to their repective entities in the organization such as teachers,students etc. Teachers can create channels as per their requirements to interact with the students. Channel features includes:- Realtime interactive chat, Realtime video streaming along with whiteboard and screen sharing like attrcative features,etc. User can join to the only one organization and multiple channels at a time. Users in the organization can participate in the assessments uploaded by the admins in their respective channel and can watch their rankings in the leaderboard section section of the organization which indicates continuous progress in the form of points & graph. User can also view their profile which is updated along with the active participation of the user on our platform.

  1. Include features and their usecases in bullet points

🔗Links

🤖Tech-Stack

Front-end

  • Next Js
  • React Js
  • Tailwind CSS
  • Material UI
  • Framer Motion

Back-end

  • NodeJS
  • ExpressJS
  • Flask
  • Cloudinary (for storing media content)

Database

  • MongoDB

API Management Platform:

  • Postman

Project Deployment:

  • Vercel (Frontend)
  • Onrender(Backend)

📈Progress

List down all the fully implemented features in your project

  • Customized channel creation.
  • General channel where everyone in the organization can interact.
  • Exclusive Group chat for the channels for texting,sharing important files such as pdfs, ppts or doc, or for just bickering.
  • Realtime video meet feature for one to one interaction along with screen sharing capability.
  • White board functionality which helps users for demonstration purpose.
  • Assessment for users for testing their skills or for teachers to conduct TAs, all just a click away, just upload your pdf file and get quizzes generated automatically with points scores.
  • Leaderboard to keep track of users points and to keep their competitive fire ignited.
  • Graphs and Charts to track the progress of a user to correctly gauge his skills and to show users journey along the way.

List down all the partially implemented features in your project

  • Scheduling of the assessments.
  • Scheduling the events in platform itself, (such as scheduling hackathons and have our AI calculate the scores and rankings).

🔮Future Scope

List down all the future plans for the project here

  • Scheduling the events in platform itself, (such as scheduling hackathons and have our AI calculate the scores and rankings).
  • Exclusive user mental health checker.

💸Applications

Your virtual group study platform contributes to solving real-life problems by:

  • Enhancing remote learning and collaboration.
  • Bridging the gap in education by providing equal access to all the students in the organization.
  • Improving communication and teamwork in various settings.
  • Facilitating dynamic learning channels and adaptable structures.
  • Offering assessment and skill development opportunities.

Monetization can be achieved through premium features, collaborations with institutions, and certification programs.

🛠Project Setup

Frontend:-

  • Installed node js runtime on local machine.
  • Then created next js project using npx package manager.

Backend:-

  • Create new folder & then init the project using npm init & installed required dependencies.
  • Then created new account on the MongoDB atlas.
  • Created new project on the atlas platform.
  • Then connected to the project using mongodb database connection string using mongoose in the express app.

Others can simply fork the repository & then clone it in their machine. Once done they should run 'npm i --force' to install all the required dependecies.Then can simply run 'npm run dev' to start the project.

💻Usage

  • Users must required to add .env file in order to run the project.
  • Then they can simply run 'npm run dev' to start the project.

📱Screenshots

Screenshot from 2024-02-08 16-26-19

Screenshot from 2024-02-08 16-26-47 Screenshot from 2024-02-08 16-26-55 Screenshot from 2024-02-08 16-28-09 Screenshot from 2024-02-08 16-28-23 Screenshot from 2024-02-08 16-29-42 Screenshot from 2024-02-08 16-30-24 Screenshot from 2024-02-08 16-31-42 Screenshot from 2024-02-08 16-45-53 Screenshot from 2024-02-08 16-31-11