https://github.com/dacmarcell/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.
https://github.com/dacmarcell/edux
docker express postgresql prisma typescript
Last synced: 3 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/dacmarcell/edux
- Owner: dacmarcell
- Created: 2024-02-09T22:40:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-19T00:40:04.000Z (9 months ago)
- Last Synced: 2025-01-15T20:19:24.102Z (4 months ago)
- Topics: docker, express, postgresql, prisma, typescript
- Language: TypeScript
- Homepage: https://devmarcell.vercel.app/projects/edux
- Size: 317 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
📖 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
```http
GET /api/v1/students
```
#### Create a Student
```http
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
```http
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
```http
DELETE /api/v1/students/:id
```
#### Returns all Teachers
```http
GET /api/v1/teachers
```
#### Create a Teacher
```http
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
```http
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
```http
DELETE /api/v1/teachers/:id
```
#### Returns all Courses
```http
GET /api/v1/courses
```
#### Creates a Course
```http
POST /api/v1/courses
```
| Parameters | Type | Description |
| :---------- | :--------- | :------------------------------------------ |
| `name` | `string` | **Mandatory**. Course Name |
#### Update a Teacher
```http
PUT /api/v1/courses/:id
```
| Parameters | Type | Description |
| :---------- | :--------- | :------------------------------------------ |
| `name` | `string` | **Mandatory**. Course Name |
#### Delete a Teacher
```http
DELETE /api/v1/courses/:id
```
### Enroll Student
```http
POST /api/v1/enroll/:studentID
```
| Parameters | Type | Description |
| :---------- | :--------- | :------------------------------------------ |
| `courseID` | `string` | **Mandatory**. ID of the course which the student will be enrolled |
### Unenroll Student
```http
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
```http
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
```http
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
```http
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
```http
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
- [@marcelldac](https://www.github.com/marcelldac)