/edux

O EduControl é uma plataforma avançada de gestão escolar que oferece uma abordagem integrada e eficiente para administrar todas as operações essenciais de uma instituição educacional.

Primary LanguageTypeScript



📖 EduX 📖

EduX - School System Management

The EduX is an advanced school management platform that offers an integrated and efficient approach to administering all essential operations of an educational institution. From tracking student performance to resource management and communication with parents, EduX simplifies and enhances every aspect of the school environment.

Features

  • Create, Read, Update and Delete Users
  • Create, Read, Update and Delete Courses
  • Create, Read, Update and Delete Teachers
  • Enroll Student in a course
  • Unenroll Student of a course
  • Enroll Teacher in a course
  • Unenroll teacher of a course
  • Login student and teacher

EduX Documentation

Returns all students

  GET /api/v1/students

Create a Student

  POST /api/v1/students
Parameters Type Description
firstName string Mandatory. Student's First Name
lastName string Mandatory. Student's Last Name
email string Mandatory. Student's Email
password string Mandatory. Student's Password

Update a Student

  PUT /api/v1/students/:id
Parameters Type Description
firstName string Mandatory. Student's First Name
lastName string Mandatory. Student's Last Name
email string Mandatory. Student's Email
password string Mandatory. Student's Password

Delete a Student

  DELETE /api/v1/students/:id

Returns all Teachers

  GET /api/v1/teachers

Create a Teacher

  POST /api/v1/teachers
Parameters Type Description
name string Mandatory. Teacher's name
email string Mandatory. Teacher's email
isCoordinator boolean Mandatory. If teacher is coordinator or not
courseName string Mandatory. Name of course which teacher will be enrolled in

Update a Teacher

  PUT /api/v1/teachers/:id
Parameters Type Description
name string Mandatory. Teacher's name
email string Mandatory. Teacher's email
isCoordinator boolean Mandatory. If teacher is coordinator or not
courseName string Mandatory. Name of course which teacher will be enrolled in

Delete a Teacher

  DELETE /api/v1/teachers/:id

Returns all Courses

  GET /api/v1/courses

Creates a Course

  POST /api/v1/courses
Parameters Type Description
name string Mandatory. Course Name

Update a Teacher

  PUT /api/v1/courses/:id
Parameters Type Description
name string Mandatory. Course Name

Delete a Teacher

  DELETE /api/v1/courses/:id

Enroll Student

  POST /api/v1/enroll/:studentID
Parameters Type Description
courseID string Mandatory. ID of the course which the student will be enrolled

Unenroll Student

  POST /api/v1/unenroll/:studentID
Parameters Type Description
courseID string Mandatory. ID of the course which the student will be unenrolled

Enroll Student via E-mail

  POST /api/v1/enroll
Parameters Type Description
studentEmail string Mandatory. Student Enrollment Email
courseName string Mandatory. The name of the course that will receive a new student

Unenroll Student via E-mail

  POST /api/v1/unenroll
Parameters Type Description
studentEmail string Mandatory. Student Enrollment Email
courseName string Mandatory. The name of the course that will receive a new student

Enroll Teacher

  POST /api/v1/teacher-enroll
Parameters Type Description
teacherEmail string Mandatory. Teacher Enrollment Email
courseName string Mandatory. The name of the course that will receive a new student

Unenroll Teacher

  POST /api/v1/teacher-unenroll
Parameters Type Description
teacherEmail string Mandatory. Teacher Enrollment Email
courseName string Mandatory. The name of the course that will receive a new student

Author