UBEMath Project

Game Software to help the Elementary School students in Mathematics' learning!
Explore the API Spec »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
• How to install?
• Built With
• Contact
• Acknowledgements

About The Project

This project intends to provide an equal opportunity to learn the 9th-grade Mathematics of the elementary school, based on an interpretation of a series of researches about the factors, difficulties, and various coefficients that are associated with the partiality of Brazilian students.

Therefore, investigates that has a weakness in the current scenario, since the need for change and the long-term perspective, represent a distant pattern from what is consistent with the capacity for intellectual strengthening. Consequently, the country’s technical progress becomes infeasible, as well as the development of individual skills.

The exposed syllogism allows the comprehension of a particular line of reasoning, which demonstrates the deficit of society, precisely because it ignores the importance of the foundation of logical and structured knowledge, mainly due to the disharmony with Mathematics.

Essentially, the project is related to the methodology of progress through gamification, where there will be a journey to be completed.

The student will have a long way to go, with several obstacles, being represented by 9th-grade mathematics segments. Also, covering scenarios, characters, and resources, essential for the advancement and reflection of what is considered attractive to young people of this age group.

Overall, the game will be integrated into a platform with several associated features, allowing the constant interaction of the student and favoring a consequent greater understanding of these fundamental areas of Mathematics.

How to install?

1. To run the backend, follow these steps:

• Navigate to the backend folder and install the dependencies:

// Navigate to the backend folder
$ cd backend

// Install application dependencies
$ yarn

• Install MySQL, MongoDB, Redis and Adminer Docker images using docker-compose:

// Run the Docker images
$ docker-compose up -d

• Create a file called .env based on .env.example and enter your AWS credentials;
• Create a file called .ormconfig.json based on .ormconfig.example.json and insert the MySQL host and port according to the previously installed Docker images, in addition to exchanging the src recipient for dist and .ts for .js;
• Configure the credentials of the MySQL Docker image using the following commands:

// Enter the MySQL image bash
$ docker exec -it IMAGE_NAME bash
// Enter the MySQL image root
$ mysql -u root -p
// Change the password
$ ALTER USER root IDENTIFIED WITH mysql_native_password BY ‘ROOT_USER_PASSWORD’;

• Run the database migrations using the command:

// Run the migrations
$ node_modules/.bin/typeorm migration:run

• Add a no-restart configuration for each Docker image using the command:

// Change the configuration of the Docker images
$ docker update --restart=unless-stopped ID_DA_IMAGEM

• Start the server using the command:

// Start the server
$ yarn dev:server

2. To run the frontend, follow these steps:

• Navigate to the frontend folder and install the dependencies:

// Navigate to the frontend folder
$ cd frontend

// Install application dependencies
$ yarn

• Start the application using the command:

// Start the application
$ yarn start

Built With

• Framework for platform frontend: React.js
• Engine for game creation: Unity
• Backend Framework: Node.js
• Database technology: MySQL, MongoDB, and Redis
• Backend data processing technology: TypeORM
• Technology for testing implementation: Jest
• API documentation tool: SwaggerHUB
• Prototyping tool: Adobe XD
• Diagram creation tool: LucidChart

Contact

Lorenzo Windmoller Martins - LinkedIn - [email protected]

Samuel Albuquerque de Paiva - [email protected]

Vinícius Andrade Perrone - LinkedIn - [email protected]

Acknowledgements

• README Template by othneildrew
• Img Shields