https://github.com/rakibul-islam-raju/ums-auth-service
https://github.com/rakibul-islam-raju/ums-auth-service
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rakibul-islam-raju/ums-auth-service
- Owner: rakibul-islam-raju
- Created: 2023-06-02T06:12:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-27T16:45:51.000Z (over 1 year ago)
- Last Synced: 2025-01-12T21:30:06.707Z (5 months ago)
- Language: TypeScript
- Size: 344 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# University Management System Authentication Service
This is the documentation for the Authentication Service component of the University Management System. The Authentication Service provides authentication and authorization functionalities for the three main roles in the system: Admin, Student, and Faculty. It is built using TypeScript, Express.js, Zod validation, and MongoDB.
## Functional Requirements
### Student
- Student can login and log out.
- Student can manage and update their profile.
- Student can update certain fields.
### Admin
- Admin can log in and log out.
- Admin can manage and update their profile.
- Admin can only update certain fields.
- Admin can manage user accounts:
- Change Password
### Faculty
- Faculty can log in and log out.
- Faculty can manage and update their profile.
- Faculty can only update certain fields.
## API Endpoints
### User
- `POST /users/create-student`
- `POST /users/create-faculty`
- `POST /users/create-admin`
### Student
- `GET /students`
- `GET /students?searchTerm=fr797`
- `GET /students?page=1&limit=10&sortBy=gender&sortOrder=asc`
- `GET /students/:id`
- `PATCH /students/:id`
- `DELETE /students/:id`
### Faculty
- `GET /faculties`
- `GET /faculties?searchTerm=john`
- `GET /faculties?page=1&limit=10&sortBy=gender&sortOrder=asc`
- `GET /faculties/:id`
- `PATCH /faculties/:id`
- `DELETE /faculties/:id`
### Admin
- `GET /admins`
- `GET /admins?searchTerm=us88`
- `GET /admins?page=1&limit=10&sortBy=gender&sortOrder=asc`
- `GET /admins/:id`
- `PATCH /admins/:id`
- `DELETE /admins/:id`
### Academic Semester
- `POST /academic-semesters/create-semester`
- `GET /academic-semesters`
- `GET /academic-semesters?searchTerm=fal`
- `GET /academic-semesters?page=1&limit=10&sortBy=year&sortOrder=asc`
- `GET /academic-semesters/:id`
- `PATCH /academic-semesters/:id`
- `DELETE /academic-semesters/:id`
### Academic Department
- `POST /academic-departments/create-department`
- `GET /academic-departments`
- `GET /academic-departments?searchTerm=math`
- `GET /academic-departments?page=1&limit=10&sortBy=title&sortOrder=asc`
- `GET /academic-departments/:id`
- `PATCH /academic-departments/:id`
- `DELETE /academic-departments/:id`
### Academic Faculty
- `POST /academic-faculties/create-faculty`
- `GET /academic-faculties`
- `GET /academic-faculties?searchTerm=com`
- `GET /academic-faculties?page=1&limit=10&sortBy=title&sortOrder=asc`
- `GET /academic-faculties/:id`
- `PATCH /academic-faculties/:id`
- `DELETE /academic-faculties/:id`
### Authentication
- `POST /auth/login`
- `POST /auth/change-password`
- `POST /auth/refresh-token`
Postman Documenttaion: [Click Here](https://documenter.getpostman.com/view/26682150/2s93zB72V9#acc25f08-de78-478b-809d-837ce239d2b3)