touutae-lab / fastgraduation-api

Fast Graduation Backend API Develops with Python Flask API

Flask API

fastgraduation-api's Issues

Make Login with SuperToken system.

Create Login with Username and Password System implement with Supertoken Framework,
Most of work you can design and implement as you desired.

• Login system works
• Handle SSN key

GET `/profile`

Add pre-commit hooks

Add pre-commit hooks that will automatically run the following dependencies after every commit locally.

Formatter & Linter

• black
• isort
• flake8

Unit Test

• PyTest

Documentation

• Sphinx (see #12)

Admin System

The Admin System is an important part that let system moderators manage the overall data and users.

• User Management
• Course Information
• Course Category Information
• Study Program Information
• Study Plan Information

Make a 4-year plan management API

Make an API that provides the CRUD operation to make a timeline plan for a particular study program.

For example,

API Routes

Instruction

• One route one file, in either student/ or admin/ directory.
• Use the Figma prototype as models for the system.

Part Student /student

• GET /browse_course?q={search text}&init=1 @dward2nd
• #25 @NMWANNABEAIENGINEER
• GET/POST /enrollment @dward2nd
  • GET enrolled course list
  • POST edit enrolled course list
• GET/POST /suggest?init=1 @Touutae-lab
  • GET suggestion based on enrollment alone
    -[deprecated] POST suggestion with modification from a user

Part Admin /admin

student

• POST /student/add @NMWANNABEAIENGINEER
• GET /student/browse?q={search text} @NMWANNABEAIENGINEER
• GET/POST /student/edit/<student_id> @NMWANNABEAIENGINEER
• GET/POST /student/delete/<student_id> @NMWANNABEAIENGINEER

course

• POST /course/add
• GET /course/browse?q={} @NMWANNABEAIENGINEER
• GET/POST /course/edit/<student_id> @NMWANNABEAIENGINEER
• GET /course/delete/<student_id>

course category

• POST /course_category/add @ph0pz
• GET /course_category/browse?q={} @ph0pz
• GET/POST /course_category/edit/<category_id> @ph0pz
• GET /course_category/delete/<category_id> @ph0pz

program

• POST /program/add @NMWANNABEAIENGINEER
• GET /program/browse?q={} @NMWANNABEAIENGINEER
• GET/POST /program/edit/<student_id> @NMWANNABEAIENGINEER
• GET /program/delete/<student_id> @NMWANNABEAIENGINEER

program plan

• POST /plan/add @ph0pz
• GET /plan/browse?q={} @ph0pz
• GET/POST /plan/edit/<plan_id> @ph0pz
• GET /plan/delete/<plan_id> @ph0pz

planned timeline for each plan

• GET /plan_/browse?q={} @ph0pz
• GET/POST /plan/edit/<student_id> @ph0pz
• GET /plan/delete/<student_id> @ph0pz
• อันนี้มันคืออยู่ใน edit ของ program ที่น้ำมนต์ทำไหม

Add a documentation

The following tasks must be finished

• Documentation website
• Docs string formating.

Make a plan suggestion system for a particular student

• Receive the enrollment information from the database and analyse them, then save the suggestion result in the database. (The database schema for suggestions will be added later)

• Make an API GET route that returns the suggestion result to the frontend. The response may be a JSON object that the web server can understand.

Make sure that

• You do not put everything in app.py but to put things in separate files. Consider Separation of Concerns

API Routes

Part Student

• GET /api/student/browse_course

Assignee: add yourself here

Description: This route sends a list of available courses to users. This route corresponds to the Search page.

Params:

• q=[keywords to search] (optional): a query text that a user may input in the search box.
• init=1 (optional): a flag whether should we return a predefined list of courses regardless of the enrolled courses. This param must come with the exact value 1, or it would get rejected as if such the param had not been sent.

Response:

• If there are no params, use the user's list of enrolled courses to determine the order of courses to respond to; the most recommended — important — course comes first.
• If q exists, respond with the order based on relevance instead — without using the user's enrolled courses to determine the order. However, the student's
• If init=1 exists, use the predefined plan — the exact same as the ones written by the department of CS. init will ignore any other params, especially q if we provide one. This param must come with the exact value 1, or it would get rejected as if such the param had not been sent.

Response Format

{
    "status": 200,
    "msg": "OK",
    "data": [
        {
            "course_id": [string of 6-digit course ID],
            "course_name_th": [string of course name in Thai],
            "course_name_en": [string of course name in English],
            "possible_category": [
                {
                    "cat_id": [integer id of the category],
                    "cat_name_th": [category name in Thai],
                    "cat_name_en": [category name in English],
                    "cat_abbr_th": [abbreviated name in Thai],
                    "cat_abbr_en": [abbreviated name in English]
                },
                // ...
            ]
        },
        // ...
    ]
}

Note: params are pairs of a key and a value appending at the end of URLs following the ? symbol. For instance,

http://localhost:8000/myroute?a=5&b=2

has 2 params: a with value 5, and b with value 2.

Make an API to manage enrollment data from students

An API that manages the enrollment history of students, will be essential for the suggestion.