Giter Club home page Giter Club logo

courseofaction's Introduction

CourseOfAction

Purpose:

This application can be accessed via any browser on mobile and PC for UofT students to easily track courses, assessments and grades throughout their semester.

Usage & Current Functionality:

You need to have a valid UofT account to use this application as we use SSO for authentication.

API Documentation

If testing on deployed website then:

Base URL = https://mcsapps.utm.utoronto.ca/

Otherwise, if testing on localhost then:

Base URL = http://localhost:8989/

Note: All request headers must contain the Utorid(default behaviour for all MCS apps). The base URL will precede all the routes listed below.

Routes

GET /coa/app/*
Purpose: Serve static files for the frontend app
Expected Data: None
Returns: HTML, CSS and JS files as requested
GET /coa/api/application-start
Purpose: Fetch courses for current user
Expected Data: None
Returns: Courses and User's notification preference
POST /coa/api/update-user-notification
Purpose: Setting notification preference for user
Expected Data: { "notification": 0/1 }
Returns: User data with updated values
POST /coa/api/add-course
Purpose: Creating a new course and add it for current user
Expected Data: Course data as a json object
Returns: {"message": "success/error message"}
POST /coa/api/delete-course
Purpose: Deletes the provided course if it exists for current user
Expected Data: Course code as a json object
Returns: {"message": "success/error message"}
POST /coa/api/update-course
Purpose: Updates data if course exists for current user (ex: familiarity, notification)
Expected Data: Course data as a json object
Returns: {"message": "success/error message"}
POST /coa/api/update-assessments
Purpose: Updates assessments for provided course if it exists for current user
Expected Data: Course data as a json object
Returns: {"message": "success/error message"}
POST /coa/api/parse-syllabus
Purpose: Allows syllabus upload for extracting assessment info
Expected Data: file upload as pdf
Returns: Parsed assessments as json or error message

Install dependencies and run on your local machine

Nodejs and Python should be installed on your machine. Clone the project onto your local machine.

git clone https://github.com/milindvishnoi/CourseOfAction

Install all the python packages and start backend server. Go into the backend folder and install all pip packages:

cd backend
pip install -r requirements.txt
flask run -p 8989

To install all the frontend dependencies and run the react application:

cd frontend
npm install
npm start

courseofaction's People

Contributors

milindvishnoi avatar miteshghimire avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.