Skip to content

husain3012/lms-backend

Repository files navigation

REST API server for LMS project, Team 4

Members:

ENV Vars

DATABASE_URL=Your_Postgres_Database_URL
APP_SECRET=token_encryption_secret_for_jwt
NEW_DATABASE=true if you want fresh database at every run

API DOCS

Teacher Routes

Use URL Method Params Access Status
Login /api/teacher/login POST email, password Public OK
Sign up /api/teacher/signup POST name, email, password Public OK
Update /api/teacher/update_details POST name/oldPassword,newPassword Public OK

Student Routes

Use URL Method Params Access Status
Login /api/student/login POST email, password Public OK
Sign up /api/student/signup POST name, email, password Public OK
Update /api/student/update_details POST name/oldPassword,newPassword Public OK

Classroom Routes

Use URL Method Params Access Status
Get classroom by id /api/classroom/:id GET __ Private OK
Create classroom /api/classroom/create POST name, description Private/Teacher OK
Get all created classrooms /api/classroom/created GET __ Private/Teacher OK
Join a classroom by code /api/classroom/join POST classroom_id Private/Student OK
Get all joined Classroom /api/classroom/joined GET __ Private/Student OK

Notes Routes

Use URL Method Params Access Status
Post Notes /api/notes/post_notes/:classroom_id POST name, description PUBLIC OK
Get Notes /api/notes/get_notes/:classroom_id GET __ PUBLIC OK
Get Note by id /api/notes/get/:note_id GET __ PUBLIC OK

DEVELOPER/ADMIN ROUTES

They are just for debugging purposes

Use URL Method Params Access Status
Get All Teachers /api/teacher/get_all_users GET __ PUBLIC OK
Get All Students /api/student/get_all_users GET __ PUBLIC OK
Add dummy Teachers /api/teacher/add_fake_users POST number PUBLIC OK
Get dummy Students /api/student/add_fake_users POST number PUBLIC OK

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages