G-Scores

Overview

This is G-Scores, a web application for looking up the result of the High School Graduation Examination.

This application uses MySQL as database, Django as backend and vanilla JavaScript using JQuery with HTML and CSS as frontend. Each part of the application is containerized and can be deployed locally in one go using Docker Compose. An OOP design presents in the inheritance of Models in the Django project.

The frontend web application's layout is only designed to view on Desktop.

Requirements

• Docker (Docker CLI and Docker Compose).
• Internet connection.

Setup

At the root of this repository, copy the file db.docker.env-example to a new file db.docker.env and change the passwords according to your preference. Then, run:

# May takes 1-2 minutes to build
docker-compose up --build --detach

To stop the containers, run:

docker-compose down -v

Usage

Frontend

After the containers started, go to http://localhost:8080 to access the frontend.

Backend

The backend serves as a CRUD API at http://localhost:3000:

• GET /student/{registration number}/:
  • Get the student's scores by his/her registration number.
• GET /report/{subject name}/:
  • Get the numbers of students by level in the specified subject (toan, ngu_van, etc.).
• GET /top/:
  • Get top 10 students in Group A.

To-Dos

• Prepare the CSV file to load to the MySQL database
• Load raw data into the database, see file db/Dockerfile
• Feature: Check scores by registration number, i.e. sbd
• Feature: Make report chart of numbers of students with scores in 4 levels by subjects
• Feature: List top 10 students of group A (math, physics, chemistry)
• Feature: Make a frontend
• Optional Feature: Use Docker
• Optional Feature: Responsive design (care for desktop, tablet and mobile phone users)
• Optional Feature: Deploy a Live Demo
  • localhost was hard-coded into the code, so it may takes some times to make a live demo
• Optional Feature: Download graphs as images
• Optional Feature: Export tables as CSV files or Excel spreadsheets