Math Dojo

This program is a full-stack web app for users to practice math problems(it's sort of like my own mini-version of MyMathLab, WebAssign, and various other STEM practice platforms). It provides randomly generated basic math problems, and also checks the user's answers to make sure they are correct.

This project uses the following tools:

• HTML + CSS + Bootstrap
• JavaScript
• Node.js + Express
• SQL + SQLite

The client-side code(HTML, CSS, and client-side Javascript) is all in the "public" folder, and the server-side code(Javascript/Node.js) is in the "app.js" and "MathFunction.js" files. This is my first experience with writing my own API with Node.js and working with a database. I created an API based on math which currently has two functionalities:

1. Generate random practice math problems and send them to the API caller
2. Compute answers to math problems given by the API caller, and return the answers

In its current state, this program currently only involves arithmetic problems

Below is the official documentation for my math API

My Math API Documentation

My Math API provides randomly generated practice arithmetic problems and also computes answers to problems given by the API user.

Functionality 1: Get randomly generated practice arithmetic problem

Request Format: /practice

Request Type: GET

Returned Data Format: JSON

Description: Returns a JSON object containing 100 randomly generated practice arithmetic problems

Example Request: /practice

Example Response:

{
"0": "2 - 2"
"1": "1 + 1",
"2": "2 * 5 - 7 + 1,
...
"99": "5 * 5 - 5
}

Error Handling:

• N/A: The API call is made through my client-side JavaScript and the user doesn't have a connection to the API from the Math Dojo website.

Functionality 2: Get answer to arithmetic problem

Request Format: /solve/:expression

Request Type: GET

Returned Data Format: Plain Text

Description: Accepts a math arithmetic problem as a route(required) parameter, then sends back the answer to that arithmetic problem. My algorithm uses Dijkstra's shunting yard algorithm to compute the problem.

Example Request: /solve/2+(2-2)

Example Response:

"2"

Error Handling:

• Possible 400 (invalid request) errors (all plain text):
  • If passed in an invalid arithmetic problem, returns an error with the message: `Given problem {problem} is not a valid arithmetic problem!

NOTE: It isn't possible to send an incorrect math problem from within the Math Dojo program, since all problems sent from Math Dojo were generated by my(this) API, and my API cannot generate a problem in an incorrect format. This error handler is just here just in case this API is accessed from outside the Math Dojo program.