Tutor is an open-source application for students, made by students. Using Tutor, you can share helpful information you have stumbled upon online, summaries you wrote, and have all the information you need for every course at the tip of your fingertips.
Sign up to the subjects your'e enrolled in and see what helped other students understand the material better and get great grades in the course.
If your school uses Moodle, Tutor can automatically check for updated HW grades and display your grades in one simple-to-use dashboard, so you know where your'e standing.
The dashboard shows the student's current grades and all courses [s]he is enrolled in.
From the main page, the user can choose a specific course to look at and see all data relevant to this specific course. The user has the ability to sign up to courses, create courses, and to add/remove data from course.
Implemented with Flask and PostreSQL using the following components:
- Table for all courses available in the app
- Table for each course, filled with the data relevant for that specific app.
- User has the ability to add and remove courses, as well as add and remove data from each course's table.
Implemented with bootstrap.
User registration implemented in DB with hashed passwords. User login implemented with flask-login package.
- github actions
- pytest
- Can we implement feature that gets grades from Moodle (Privacy issue)? If not, can add feature that user's add their grades manually.
These instructions will get you a copy of the project up and running on your local machine.
What things you need to install the software and how to install them:
- Download and Install Vagrant and Virtual Box on your local computer
- Clone/ Download the zip file from the Groot repository to your local computer
A step by step series that tell you how to get Project Tutor up and running
- Clone + Fork the repository
- Open command prompt and navigate to the local directory where all the files are
- Spin the environment using:
vagrant up
-
open your browser and nevigate to http://0.0.0.0:5000/
-
When finished, tear down the environment using:
CTRL + C
vagrant destroy -f
In this project we are using pipenv as a package and virtual environment manager.
We will supply a Pipfile, a Pipfile.lock and a bootstrap file that will install all the needed libraries in the future.
These are the main libraries used:
Python 3.7
Flask 1.1.2
PostgreSQL 10.14