This project representing the institute management system BackEnd

Project Name: Institute Management System

Project Demo Link: Institute Management System

FrontEnd Repository: Institute Management System FrontEnd

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:5000 to view it in your browser.

Available Roles

1. Admin => role: 1

2. Institute => role: 2

3. Student => role: 3

4. Parent => role: 4

Available APIs

Institute APIs

Register a new user

http://localhost:5000/api/users/register

Sample Request Body

{
    "name":"Kajanan",
    "email":"[email protected]",
    "password":"1234567",
    "role":2,
    "phoneNumber":"0762925096",
    "address":"Vavuniya",
    "profilePic":"img-url"
}

Auth a user

http://localhost:5000/api/users/register

Sample Request Body

{
    "email":"[email protected]",
    "password":"1234567",
}

Update a user

http://localhost:5000/api/users/:userId/profile

Sample Request Body (Update only send updated fields)

{
    "name":"Kajanan",
    "email":"[email protected]",
    "password":"1234567",
    "phoneNumber":"0762925096",
    "address":"Vavuniya",
    "profilePic":"img-url"
}

Get A user

http://localhost:5000/api/users/:userId/profile

Get All User

http://localhost:5000/api/users/allprofile

Logout a user

http://localhost:5000/api/users/logout

Delete a user

http://localhost:5000/api/users/:userId/deleteUser

Student APIs

Register a new student

http://localhost:5000/api/institute/:instituteId/createStudent

Sample Request Body

{
    "name":"Kajanan",
    "age":"[email protected]",
    "password":"1234567",
    "role":2,
    "phoneNumber":"0762925096",
    "dob":"03/05/2000"
    "nicFront":""
    "nicBack":""
    "email":""
    "subjects":["String"]
    "address":"Vavuniya",
    "profilePic":"img-url"
    "gender":"img-url"
    "parentName":"img-url"
    "instituteId":"img-url"
    "nicNo":"img-url"
    "location":"img-url"
}

Update a student

http://localhost:5000/api/institute/:instituteId/student/:id

Sample Request Body (Update only send updated fields)

{
    "name":"Kajanan",
    "age":"[email protected]",
    "phoneNumber":"0762925096",
    "address":"Vavuniya",
    "profilePic":"img-url"
    "gender":"img-url"
    "dob":"03/05/2000"
    "nicFront":""
    "nicBack":""
    "email":""
    "subjects":["String"]
    "parentName":"img-url"
    "instituteId":"img-url"
    "nicNo":"img-url"
    "location":"img-url"
}

Get A Student

http://localhost:5000/api/institute/:instituteId/student/:id

Get All Students

http://localhost:5000/api/institute/:instituteI/getAllStudents

Delete Student

http://localhost:5000/api/institute/:instituteId/student/:id

Marks APIs

Add Marks

http://localhost:5000/api/institute/:instituteId/createMarks

Sample Request Body

{
    "subject": "Maths",
    "studentId": "64aaf99d5220f71ec9650b47",
    "marks":"92",
    "date": "2023-07-15"
}

Add Marks List

http://localhost:5000/api/institute/:instituteId/createMarksList

Sample Request Body

[
    {
        "subject": "Maths",
        "studentId": "64aaf99d5220f71ec9650b47",
        "marks":"92",
        "date": "2023-07-15"
    },{
        "subject": "Maths",
        "studentId": "64aaf99d5220f71ec9650b47",
        "marks":"92",
        "date": "2023-07-15"
    },{
        "subject": "Maths",
        "studentId": "64aaf99d5220f71ec9650b47",
        "marks":"92",
        "date": "2023-07-15"
    }
]

Edit Marks

http://localhost:5000/api/institute/:instituteId/createMarks

Sample Request Body (Update only send updated fields)

{   "subject": "Maths",
    "studentId": "64aaf99d5220f71ec9650b47",
    "marks":"92",
    "date": "2023-07-15",
    nicNo:""
}

Get Marks By Student

http://localhost:5000/api/institute/:instituteId/student/:studentId/marks

Get All Marks

http://localhost:5000/api/institute/:instituteId/getAllMarks

Delete Marks

http://localhost:5000/api/institute/:instituteId/marks/:marksId/deleteMarks

Fees APIs

Add Fees

http://localhost:5000/api/institute/:instituteId/student/:studentId/fees

Sample Request Body (Update only send updated fields)

{
    "method": "Online",
    "status": "64aaf99d5220f71ec9650b47",
    "feesAmount":"92",
    "date": "2023-07-15"
    paySlip:""
}

Edit Fees status

http://localhost:5000/api/institute/:instituteId/student/:studentId/fees/:feesId/:status

getAllFees

http://localhost:5000/api/institute/:instituteId/fees

Broadcast APIs

Add Broadcast

http://localhost:5000/api/institute/:instituteId/broadcast

{
    "message": "No class createdAt createdAt",
    "messageTopic": "Cancel class createdAt createdAt",
    "sender":"Chemistry",
}

getBroadcastByStudent

http://localhost:5000/api/institute/:instituteId/student/:studentId/broadcast

Calender APIs

Add Calender

http://localhost:5000/api/institute/:instituteId/calender

{
    "title": "No class",
    "start": "No class",
    "end":"2021-07-15",
}

getCalender

http://localhost:5000/api/institute/:instituteId/calender

Delete Calender

http://localhost:5000/api/institute/:instituteId/calender/:calenderId/

Edit Calender

http://localhost:5000/api/institute/:instituteId/calender/:calenderId/

{
    "title": "No class",
    "start": "No class",
    "end":"2021-07-15",
}

Appointment APIs

Add Appointment

http://localhost:5000/api/institute/:instituteId/student/:studentId/appointment

{
    "topic": "No class",
    "date": "No class",
    "time":"2021-07-15",
    "description":"2021-07-15",
}

getAllAppointments

http://localhost:5000/api/institute/:instituteId/getAllAppointments

updateAppointment

http://localhost:5000/api/institute/:instituteId/student/:studentId/appointment/:id

Sample Request Body (Update only send updated fields)

{
    "topic": "No class",
    "date": "No class",
    "time":"2021-07-15",
    "description":"2021-07-15",
}

Career APIs

Add Career

http://localhost:5000/api/career

Sample Request Body (Update only send updated fields)

{
    "course": "No class",
    "degreeProgramme": "No class",
    "availableUniversities": "No class",
    "medium": "No class",
    "duration":"2021-07-15",
    "description":"2021-07-15",
}

getAllCareers

http://localhost:5000/api/getAllCareers

updateCareer

http://localhost:5000/api/career/:id

Sample Request Body (Update only send updated fields)

{
    "course": "No class",
    "degreeProgramme": "No class",
    "availableUniversities": "No class",
    "medium": "No class",
    "duration":"2021-07-15",
    "description":"2021-07-15",
}

deleteCareer

http://localhost:5000/api/career/:id

getAllInstituteStudents

http://localhost:5000/api/institute/students

LeaderBoards APIs

Add LeaderBoard

http://localhost:5000/api/leaderBoard

{
    "regNo": "No class",
    "name": "No class",
    "instituteName":"2021-07-15",
    "subject": "2021-07-15"
    "marks": "2021-07-15"
}

getAllLeaderBoards

http://localhost:5000/api/getAllLeaderBoards

updateLeaderBoard

http://localhost:5000/api/leaderBoard/:id

Sample Request Body (Update only send updated fields)

{
    "regNo": "No class",
    "name": "No class",
    "instituteName":"2021-07-15",
    "subject": "2021-07-15"
    "marks": "2021-07-15"
}

deleteLeaderBoard

http://localhost:5000/api/leaderBoard/:id