🎮 Game Database API

Rest API project to record and make data available about developed games.

Technologies

	Node.js
	Express
	Mongodb
	Swagger
	Docker

Prerequisites

Warning

To run the project, you must install the following tools on your machine:

• Node.js: v18 or higher.
• Docker

Installation

Clone the repository to your computer

git clone https://github.com/MichaelDouglasPIX/game-database-api.git

Access the project

cd game-database-api

Install dependencies

npm i

Run project locally

Important

Rename the .env_example into .env and change the username and password fields.

Start Docker containers

npm run start-docker

Start the server

npm run dev

Terminate Docker

npm run finish-docker

Swagger and Mongo Express

After docker and server are running, it is possible to view some services.

• Visit http://localhost:8082/ to view API documentation in Swagger UI.
• Visit http://localhost:8081/ to view the automatically generated data in mongodb.

License

MIT licensed.