/hatop

HaTop is a fully featured online assessment platform for teachers to gauge attention and material comprehension. This was a joint term project for CSC301H5, Winter 2020 at the University of Toronto

Primary LanguageJavaScriptOtherNOASSERTION

logo

Welcome to HaTop

HaTop is a fully featured online assessment platform for teachers to gauge attention and material comprehension. HaTop relies on donations from users and is therefore completely free for both students and teachers.

Features:

  • Quizzes
  • Attendance
  • In-Depth Statistics
  • Multiple Classes
  • Clean design

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To run this project locally, you need NodeJS. Please ensure you have version 6.13.4 or higher. To check your version:

npm version

Installing

This project has two major components, the frontend and the backend. Both of these run independently of eachother (as per MVC guidelines). To run this project, you need to run both the frontend and the backend.

Frontend

To run the frontend, navigate to the frontend folder and execute the following command

npm install

The below commands are to start the server

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Backend

To run the backend, navigate to the backend folder and execute the following command

npm install

The below commands are to start the server

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Interacting with the system

Once the server is up and running, you should be able to navigate to localhost:8000 and have a local copy of the project.

Built With

Authors

  • Craig D'Souza - Frontend Design (Login, Register, Navbar) - cra1gg

  • Derek Jang - Backend Design and Database - Derek-s-Jang

  • Kyle Jang - Backend Design and Database - kylej692

  • Shubham Sharma - Backend Design and Frontend Design - shub-sharma

  • Micah Flemming - Frontend Design (Quiz builder) - JalonFlems

  • Rahul Nakre - Backend Design and Database - rahulnakre

  • Davinder Jangra - Backend Design and Database - jangra99

License

This project is licensed under the MIT License - see the LICENSE.md file for details