https://github.com/thomashawk11/4agql-schoolincltd
A GraphQL API for managing school data including users, grades, and classes.
https://github.com/thomashawk11/4agql-schoolincltd
graphql nodejs react
Last synced: 6 days ago
JSON representation
A GraphQL API for managing school data including users, grades, and classes.
- Host: GitHub
- URL: https://github.com/thomashawk11/4agql-schoolincltd
- Owner: ThomasHawk11
- License: gpl-3.0
- Created: 2025-04-06T16:45:10.000Z (22 days ago)
- Default Branch: main
- Last Pushed: 2025-04-11T20:57:59.000Z (17 days ago)
- Last Synced: 2025-04-22T19:13:48.249Z (6 days ago)
- Topics: graphql, nodejs, react
- Language: JavaScript
- Homepage:
- Size: 282 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SchooInc GraphQL API
A GraphQL API for managing school data including users, grades, and classes.
## Architecture
This project follows a microservices architecture with:
- Authentication Service: Handles user registration, login, and token management
- Main Application Service: Handles all other business logic (grades, classes, etc.)
- GraphQL Mesh Gateway: Federates the GraphQL APIs from different services
- MySQL Database: Stores all application data
- PHPMyAdmin: Database management interface
### Architecture Diagram
```mermaid
flowchart TD
Client[Client/Frontend
Port: 3000] --> Gateway
subgraph Backend
Gateway[GraphQL Mesh Gateway
Port: 4000] --> AppService
Gateway --> AuthService
AppService[Application Service
Port: 4002] --> MySQL
AppService -.-> AuthService
AuthService[Authentication Service
Port: 4001] --> MySQL
MySQL[(MySQL Database
Port: 3306)]
PHPMyAdmin[PHPMyAdmin
Port: 8080] --> MySQL
end
classDef service fill:#f9f,stroke:#333,stroke-width:2px
classDef database fill:#bbf,stroke:#333,stroke-width:2px
classDef gateway fill:#bfb,stroke:#333,stroke-width:2px
classDef client fill:#fbb,stroke:#333,stroke-width:2px
class Gateway gateway
class AppService,AuthService service
class MySQL database
class Client client
class PHPMyAdmin service
```
## Prerequisites
- Docker and Docker Compose
- Node.js (for local development)
## Getting Started
1. Clone this repository
2. Run `docker-compose up` to start all services
3. Access the GraphQL playground at http://localhost:4000/graphql
4. Access PHPMyAdmin at http://localhost:8080 (username: root, password: password)
5. Access the frontend at http://localhost:3000
## Identifiants de connexion
### Professeurs
| Email | Mot de passe |
|-------|-------------|
| [email protected] | password123 |
| [email protected] | password123 |
### Étudiants
| Email | Mot de passe |
|-------|-------------|
| [email protected] | password123 |
| [email protected] | password123 |
| [email protected] | password123 |
## Seeding the Database
To populate the database with sample data:
```bash
# First, make sure the containers are running
docker-compose up -d
# Then, run the seed script in the app-service container
docker-compose exec app-service npm run seed
```
This will create sample users, classes, courses, and grades for testing.
## Services
### Authentication Service (Port 4001)
Handles:
- User registration
- User login
- Token validation
### Main Application Service (Port 4000)
Handles:
- User management (CRUD)
- Grade management
- Class management
- Statistics for grades
## API Documentation
### Authentication
#### Register a new user
```graphql
mutation {
register(email: "[email protected]", pseudo: "User Name", password: "password123", role: student) {
token
user {
id
email
pseudo
role
}
}
}
```
#### Login
```graphql
mutation {
login(email: "[email protected]", password: "password123") {
token
user {
id
email
pseudo
role
}
}
}
```
### User Management
#### Get current user
```graphql
query {
me {
id
email
pseudo
role
classes {
id
name
}
grades {
id
value
course {
name
}
}
}
}
```
#### Update user
```graphql
mutation {
updateUser(id: "1", pseudo: "New Name") {
id
pseudo
}
}
```
### Grades
#### Get my grades
```graphql
query {
myGrades {
id
value
comment
date
course {
id
name
}
}
}
```
#### Create a grade (professor only)
```graphql
mutation {
createGrade(value: 15, comment: "Good work", courseId: "1", studentId: "3") {
id
value
comment
}
}
```
### Classes
#### Get all classes
```graphql
query {
classes(sortBy: "name") {
id
name
description
year
students {
id
pseudo
}
courses {
id
name
}
}
}
```
#### Add student to class (professor only)
```graphql
mutation {
addStudentToClass(classId: "1", studentId: "3") {
id
name
students {
id
pseudo
}
}
}
```
### Statistics (professor only)
#### Get class grade statistics
```graphql
query {
classGradeStats(classId: "1") {
className
stats {
average
median
lowest
highest
count
}
}
}
```
## Testing
To run tests:
```bash
# For auth service
docker-compose exec auth-service npm test
# For app service
docker-compose exec app-service npm test
```
## GitHub Repository
[4AGQL-SchoolIncLtd](https://github.com/ThomasHawk11/4AGQL-SchoolIncLtd)