/planet

Primary LanguageGoMIT LicenseMIT

Test codecov CodeFactor

🌎 The planets api 🪐

The planets API was made to manage planets, here you can create, find, list, and delete planets.

Application architecture

This project was divided into three applications:

  • command-api: Responsible only for writing to the database.
  • processor: Responsible for processing the planets created async.
  • query-api: Responsible for reading the planets.

planet_architecture

Requirements to run:

  • 🐳 Docker compose
  • Go
  • Postman
  • 🐂 GNU Make

How to run?

  • Run docker-compose up command inside the project folder.
  • Run make run-command-api to start the command server.
  • Run make run-processor to start the processor server.
  • Run make run-query-api to start the query server.

The postman link to see the API documentation.

How to run tests?

  • Run docker-compose up command inside the project folder.
  • Run make run-test