giovanniantonaccio / states-api

This simple API consumes data from IBGE API and return formatted information about Brazilian states.

States API

This simple API consumes data from IBGE API and return formatted information about Brazilian states, using NodeJS and Express.

It uses Redis for caching.

Each service runs in a separated container and they all comunicate through a network (meetapp_network) created with docker-compose, that is being used to orchestrate the containers creation.

This repository contains two different servers, in order to show how both APIs can communicate through Docker network.

🚀 Installation

Clone the repository:

git clone https://github.com/giovanniantonaccio/states-api.git

Rename .env.example to .env (Don't need to fill DB info, we are not using). Redis is configured based on docker-compose information.

Build the container images

docker-compose build

Now you only need to run the applications:

docker-compose up -d

📚 Technologies

This project was developed with the following technologies:

• Node.js
• Express
• nodemon
• Sucrase
• Docker
• Redis
• Ioredis
• DotEnv
• VS Code with ESLint

📝 License

This project is under the MIT license. See the LICENSE for more information.

---

Made by Giovanni Antonaccio 👋 Get in touch!