tomdoyleiom / game-api

game api

Steps to build and run this application

1. Make sure you have node installed Available here
2. from the terminal run npm install
3. make sure there is a .env file at the root of the solution with values for:
   • PORT (e.g: 8080)
   • DB_CONNECTION (e.g mongodb+srv://user:[e-mail]/test?retryWrites=true&w=majority)
4. run npm run start

part 1

• create a microservice with end points of the style:
• http://localhost:8080/games/:gameId
• example: http://localhost:8080/games/1 should return the this json

part 2

• add another endpoint to your service which will return a summary of games.
• end point format: http://localhost:8080/games/report
• the report will contain:
  • the user who has added the most comments across all games
  • the game with the highest sum of likes
  • the average likes per game (rounded up to the nearest integer)
  • the output should look like this
  • might need so add some additional test data

Steps undertaken whilst creating this application.

• git init
• npm init
• added cors, express, dotenv, mongoose as dependencies.
• git ignored the node modules
• created catch all 404 routing
• created cluster on cloud.mongodb.com
• testing basic end point (get empty list)
• created trello board of tasks
• created CRUD endpoints for report
• decided to extract comments out into their own model
• built endpoint for comments
• created aggregate schemas for generating the report.
• completed the report endpoint.
• general code cleanup
• added the http-status-codes package
• updated the game logic to determine the totalLikes from the comments
• updated the report logic to determine which game has the highest rating based on the comments

API structure

GET "/games/" returns all games

GET "/games/:gameId" returns a game by its id, along with its associated comments

GET "/games/report" returns a report of all the games in the database

POST "/games" adds a new game to the db and returns it to the user

DELETE "/games/:gameId" deletes the specified game

PUT "/games/:gameId" updates a specified game

GET "/comments/:gameId" returns comments for a specified game

POST "comments" adds a new comment to the db.