Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contact

About The Project

An easy to use Student-Portal that helps students and professors keep track of deadlines and accordingly schedule later ones to keep academic scehdules clutter free.

(back to top)

Built With

• Node.js
• React.js
• Mongoose

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• nodemon

  npm install -g nodemon

Installation

1. Get the necessary environment variable via email request to student.portal.iitr@gmail.com

2. Clone the repo

   git clone https://github.com/Shreshtha13/student_portal.git

3. Install NPM packages in /portal_frontend/ and /portal_backend/

   npm install

4. Paste in .env

   MONGODB_URI='enter MONGODB_URI'
   PORT=3001
   secret='secret'

5. In portal_backend/ run

   node index.js 

   or

   nodemon index.js 

   or

   npm run dev

6. In portal_frontend/ run

   npm start 

(back to top)

Usage

Register to create an account on the portal. Log in using login credentials. Obtain list of upcoming deadlines in the deadlines tab. If the user is a professor, user gets the option to create new assignments/quizzes/exams. In the To-Do list tab, get a customizale to-do list, where every user gets to create new notes and delete them. View the class timetable in the timetable tab and calendar in the calendar tab. The calendar displays all the deadlines on the date chosen.

(back to top)