Click here for Updated Repo complete with Unit Test

This API tool is inspired by the following User Stories which allows the School Administrator to carry out administrative tasks such as registration of teachers, students, classes and subjects, update of categorical information and the generation of report on all registered Teachers' workload.

As an Administrator, I want to register Teachers, Students, Classes and Subject in a single API, so that I can use the system for administrative purposes.

As an Administrator, I should be able to generate a report on a Teacher’s workload, so that I use it for planning.

The application is written in Javascript.

• Environment: Node.js, Docker
• Web Application Framework: Express.js
• Database: MySQL 8.0, mysql2 module, MySQL Workbench(GUI)
• API Interaction: Postman
• Object-relational Mapping: Sequelize
• Unit-Testing: Jest
• Logger: Winstonjs

• Register Teacher with his/her students in a particular class for a particular subject.
• Update any registered Teacher's, Student's, Class' or Subject's information.
• Generate a report of all registered Teachers with their subjects taken and the number of classes taught for each subject.

Prior to cloning, kindly ensure the following are present in your local machine.

1. MySQL 8.0
2. MySQL Workbench
3. Docker
4. Node.js 12.xx
5. Postman

1. Git clone this repository in your desired local directory by running the following

git clone https://github.com/andicodetrf/school-admin.git

2. In the cloned directory, install all dependencies by running the following

npm install

1. Create a .env file in the same directory as the .env.sample file
2. Copy the contents of .env.sample file into your created .env file
3. Replace the mysql password 'yourmysqlpassword' in the following files with your local machine's mysql root user's password

Files to configure:

/.env
/docker-compose.yml
/config/config.js
/src/config/database.js

4. In MySQL Workbench, create a new connection with the following details

• Hostname: 127.0.0.1
• Port: 33306
• Username: root

1. Run the following to create a Docker container for the MySQL Database

• Running this command for the first time sets up the container for the database in your local machine
• Subsequent executions of this command will only start the server

npm start

2. Open the created MySQL Workbench connection and enter your password. On success, the server would log the following:

2020-10-15 11:13:36     [database.js]   INFO    Executing (default): SELECT 1+1 AS result
2020-10-15 11:13:36     [server.js]     INFO    Application started at http://localhost:3000

1. If the server is running, stop the server and run the following to create the Database Schema

sequelize db:migrate

2. For quick data population, run the following to seed data into Database Tables

sequelize db:seed:all

The Database Schema Design is based on the following assumptions:

1. A teacher can teach in multiple classes.
2. A teacher can teach multiple subjects, regardless to the same or different class.
3. 2 different teachers can teach the same subject in the same class.
4. A student can be in multiple classes.

Postman is used for performing the following API interactions.

Host: localhost

Port: 3000

http://localhost:3000[URL Endpoint]

Registers Teacher and his/her students for a particular subject in a particular class

Request Body Example:

{
  "teacher": {
    "name": "Mr. Teacher 1",
    "email": "[email protected]"
  },
  "students": [
            {
              "name" : "John",
              "email" : "[email protected]"
            },
            {
              "name" : "Jane",
              "email" : "[email protected]"
            }
  ],
  "subject": {
    "subjectCode": "ENG",
    "name": "English"
  },
  "class": {
    "classCode": "P1-I",
    "name": "P1 Integrity"
  }
}

Response Example:

Status Code: 204

Updates either Teacher's, Student's, Subject's or Class' information with one request at a time using the following registered unique fields:

• Teacher: Existing email
• Student: Existing email
• Subject: Existing subject code
• Class: Existing class code

Request Body Examples:

Teacher

{
  "teacher": {
      "email": "[email protected]",
      "updateName": "Mr. Smith",
      "updateEmail": "[email protected]"
  }
}

Student

{
  "student": {
      "email": "[email protected]",
      "updateName": "John Doe",
      "updateEmail": "[email protected]"
  }
}

Subject

{
 "subject": {
        "subjectCode": "ENG",
        "updateName": "English1",
        "updateSubjectCode": "ENG1"
  }
}

Class

{
 "class": {
        "classCode": "P1-I",
        "updateName": "P1 Unity",
        "updateSubjectCode": "P1-U"
  }
}

Response Body Example:

Response for Teacher or Student update:

{
    "status": 200,
    "message": "Person details updated"
}

Response for Subject update:

{
    "status": 200,
    "message": "Subject details updated"
}

Response for Class update:

{
    "status": 200,
    "message": "Class details updated"
}

Generates in JSON format the list of registered teachers, their subjects taken and the number of classes taught for each subject.

Response Body Example:

{
    "status": 200,
    "report": {
        "peter tan": [
            {
                "subjectCode": "ENG",
                "subjectName": "English",
                "numberOfClasses": 1
            }
        ],
        "mr. smith": [
            {
                "subjectCode": "ENG",
                "subjectName": "English",
                "numberOfClasses": 2
            },
            {
                "subjectCode": "MATH",
                "subjectName": "Mathematics",
                "numberOfClasses": 1
            }
        ]
    }
}

See Branch: api-db-test

1. Andrea Lau : [email protected]