README.md

Documentation 📕

You can see the full documentation of the project. Check the table below.

Table of Content

• Password Requeriments
• Username Requeriments
• Environment Vars
• APIv1 Schemas
  • Graphic Diagram
  • DB Schemas
    • User
    • Course
    • Subject
    • Task
    • Schedule
    • Session
• APIv1 Endpoints
  • User
    • Create new user - POST /api/v1/user/signup
    • Login with credentials - POST /api/v1/user/login
    • Join in new course - POST /api/v1/user/join
    • Leave a registered course - POST /api/v1/user/leave
    • Get all info about user - GET /api/v1/user/info
    • Get just some info about user - GET /api/v1/user/info/:keys
    • Update info of user - POST /api/v1/user/update
    • Delete your user - DELETE /api/v1/user/delete
  • Course
    • Create new Course - POST /api/v1/class/new
    • Delete a course - DELETE /api/v1/course/delete/:classcode
    • Change password of a course - POST /api/v1/course/passwordChange
    • Get tasks ID of a course - GET /api/v1/course/tasks/:classcode
    • Get schedule ID of a course - GET /api/v1/course/schedule/:classcode
    • Get subjects ID of a course - GET /api/v1/course/subjects/:classcode
  • Subject
    • Create new subject - POST /api/v1/subject/new
    • Update data of subject - POST /api/v1/subject/update
    • Delete existing subject - DELETE /api/v1/subject/delete/:subjectId
    • Get data of subject - GET /api/v1/subject/get/:subjectId
  • Task
    • Create a new task - POST /api/v1/task/new
    • Update data of task - POST /api/v1/task/update
    • Delete existing task - DELETE /api/v1/task/delete/:taskId
    • Get data of task - GET /api/v1/task/get/:taskId
  • Session
    • Create a new session - POST /api/v1/session/new
    • Update data of session - POST /api/v1/session/update
    • Delete existing session - DELETE /api/v1/session/delete/:sessionId
    • Get data of session - GET /api/v1/task/session/:sessionId