Retro games API 👾

🎮 Node.js RESTfull API for game collectors! Organize and manage all your games. 👾

Development

Environment

Verify if you have node and npm installed / updated.

---

Getting started

1 - Clone this repository:

$ git clone https://github.com/SabrinaBarros/retro-games-api.git

$ cd retro-games-api

2 - Install all dependencies:

$ npm install

3 - Configure your environment following the .env.example file.

4 - Start the project:

$ npm start

Code style

💅🏻 If you are beautiful (inside) follow the Beautiful JavaScript Code Style Guide!

All automatic tasks

• npm start - Start API and watch files for reload (development).
• npm test - Run integration tests.
• npm run server - Start API (production).
• npm run lint - Run ESlint validations for code quality.

Versioning

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

License

MIT License © Sabrina Barros