Virtual Planner is a SaaS product that allows students to organize their Google Classroom assignments and other homework in an easy-to-use, paperless app. The front-end web client uses React, and it makes requests to a Django backend.
These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.
Requirements for the software and other tools to build, test and push
Right now, Virtual Planner has a simple React front-end and Django back-end. In order to view the app, you need to run each server locally and specify the ports if you change them from the defaults.
-
Run front-end server
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
Explain how to run the automated tests for this system
Explain what these tests test and why
Give an example
Checks if the best practices and the right coding style has been used.
Give an example
Add additional notes to deploy this on a live system
- Django - Back-end Framework
- React - Front-end library
- Vercel (future) - Front-end Hosting
- MongoDB (future) - Database Hosting
- Heroku (future) - Back-end hosting
- Varun Singh - Developed front-end -
- Lior - Developed back-end -
- Billie Thompson - Provided README Template - PurpleBooth
This project is licensed under the MIT License