Towards v0.1 🎯

[G0maa]

Here's where I track my Backend progress,
according to the result of a past discussion with graduation project team members, it can be found here:
https://hackmd.io/@Noriel/SyKgN768j/

Edit this issue or add comment, will see how it goes.

[G0maa]

• Keys:
  • ✅ Done
  • ❌Not done
  • ❓ Needs more work
  • 😐 not at least manually tested
  • 🔍 I need to query/search this.
• FKs => Foreign Keys => Need effective searching somehow.
• Progress bar: ?????

Entities/Objects/Features:

• User
  • Admin
    • GET /:userId ❌
  • Teacher
    • 🔍 ✅
    • FKs: userId.
    • GET /:userId ✅
    • GET / ✅
    • POST / ✅
    • DELETE /:userId ✅
    • PUT /:userId ✅
    • PUT /:userId?reset=true ❌
  • Student
    • 🔍 ✅
    • FKs: userId, classId.
    • GET /:userId ✅
    • GET / ✅
    • POST / ✅
    • DELETE /:userId ✅
    • PUT /:userId ✅
    • PUT /:userId?reset=true ❌
  • Staff ❌
    • GET /:userId ❌
    • GET / ❌
    • POST / ❌
    • DELETE /:userId ❌
    • PUT /:userId ❌
    • PUT /:userId?reset=true ❌
  • Parent
• Subjects
  • 🔍 ✅
  • GET / ✅
  • GET /:subjectId ✅
  • PUT /:subjectId ✅
  • DELETE /:subjectId ✅
• StudyClasses
  • 🔍 ✅
  • GET / ✅
  • GET /:classId ✅
  • POST / ✅
  • PUT /:classId ✅
  • DELETE /:classId ✅
• ActiveSubjects
  • FKs: subjectId, teacherId, classId.
  • 🔍 ✅
  • GET / ✅
  • GET /:serial ✅
  • POST / ✅
  • PUT /:serial ✅
  • DELETE /:serial ✅
• Subject Material 
  • GET / (all subjects materials) ✅
  • GET /:subjectId (a particular subject material) ✅
  • POST /:subjectId (upload a file) ✅
  • GET /:subjectId/:serial (download a file) ✅
  • DELETE /:subjectId/:serial 😐
• Holidays
  • GET / ✅
  • POST / ✅
  • DELETE /:serial ✅

• Fees
  • GET / ✅
  • GET /:serial ✅
  • POST / ✅
  • PUT / ✅
  • DELETE /:serial ✅

• Grades
  • GET / ✅
  • GET /:serial ✅
  • POST / ✅
  • PUT /:id ✅
  • DELETE :/serial ✅
• ?Reports? ❌
• ?Notification: Emails - SMS? ❌

Issue numbers (Even the ones not mentioned here):

• Lots of Validations/Verifications are needed #34
• Use of middlewares for zod #32
• Separate input validation from database query #33

[G0maa]

V0.2.0 Suggestions:

• PDF Reports created server-side e.g. students of each class.
• Notifications (SMS, Email, ...)
• 2FA
• Creating group of different user roles (e.g. creating 50 students in one API request).
• Similarly, assign a group of .e.g 50 students to some class.
• Lazy deletion. (Delete doesn't actually occur till after some time) Allowing restoring deleted records.
• Some things should be "extensible" by default, i.e. easy to modify based on customer's/developer's requirements,
  • e.g. subjectId & classId
• Move I/O operations to container or some cloud service (or both).
• The notion of moving to the next year
  • Reoccurring fees.
• OOP? (NestJS or just TS)