DATABASE_URL=Your_Postgres_Database_URL
APP_SECRET=token_encryption_secret_for_jwt
NEW_DATABASE=true if you want fresh database at every run| 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 |
| 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 |
| 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 |
| 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 |
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 |