README.md

Classroom (Web)

Description

A web application for teacher and students to engage virtually.

Features

• User Authentication and Authorization.
• Teacher
  • Create Classes
  • Create Assignments
• Student
  • Join Classes
  • Submit Assignments
• Create announcements.

Technologies / Libraries Used

• ReactJS
• React Bootstrap
• NodeJS
• ExpressJS
• MongoDB

Build From Source

Prerequisite

• Node
• NPM
• Mongo

Setup

• Clone this repository.
• Start your mongo server
• In the repository's root directory, create a .env file that contains the following keys.
  1. JWT_SECRET
  2. MONGO_URI
• In the client directory, build the React application.

  npm build
  

• In the root directory of this repository, run the Node application.

  npm start
  

• Go to localhost:8080.

NOTE : For a detailed description of the API endpoints for this project, have a look at the README_API.md file.

Hosting

You can view the live project here