The game mechanics are this: you select a player and track, the game begins and you accelerate your racer by clicking an acceleration button. As you accelerate so do the other players and the leaderboard live-updates as players change position on the track. The final view is a results page displaying the players' rankings.

The game has three main views:

1. The form to create a race

2. The race progress view (this includes the live-updating leaderboard and acceleration button)

3. The race results view

1. An API. The API is provided in the form of a binary held in the bin folder. This work will be 100% in the front end.

2. HTML Views. The focus of this Project is not UI development or styling practice, so I am working already provided pieces of UI, all I have did is to call them at the right times.

In order to play this game, we need to run two things: the game engine API and the front end.

The game engine has been compiled down to a binary so that you can run it on any system. Because of this, you cannot edit the API in any way, it is just a black box that we interact with via the API endpoints.

To run the server, locate your operating system and run the associated command in your terminal at the root of the project.

Note that this process will use your terminal tab, so you will have to open a new tab and navigate back to the project root to start the front end.

If you are using a windows machine:

1. cd into the root of the project containing data.json
2. Run the following command to add the environment variable: set DATA_FILE=./data.json

If you still run into issues running the API server on your machine, sorry build your own game.

First, run your preference of npm install && npm start or yarn && yarn start at the root of this project. Then you should be able to access http://localhost:3000.

The core code base is at src/client/assets/javascript/index.js. I used asynchronous methods to achieve tasks to build this game.

The API calls are all at the bottom of the file: src/client/assets/javascript/index.js.

Below are a list of the API endpoints and the shape of the data they return. These are all of the endpoints you need to complete the game. Consult this information often as you complete the project:

[GET] api/tracks List of all tracks

• id: number (1)
• name: string ("Track 1")
• segments: number

[GET] api/cars List of all cars

• id: number (3)
• driver_name: string ("Racer 1")
• top_speed: number (500)
• acceleration: number (10)
• handling: number (10)

[GET] api/races/${id} Information about a single race

• status: RaceStatus ("unstarted" | "in-progress" | "finished")
• positions object[] ([{ car: object, final_position: number (omitted if empty), speed: number, segment: number}])

[POST] api/races Create a race

• id: number
• track: string
• player_id: number
• cars: Cars[] (array of cars in the race)
• results: Cars[] (array of cars in the position they finished, available if the race is finished)

[POST] api/races/${id}/start Begin a race

• Returns nothing

[POST] api/races/${id}/accelerate Accelerate a car

• Returns nothing