microservices-base-kafka

Basic microservices project that includes a gateway (api-gateway) and 3 microservices (user/product/client) and a messaging queue

This variation utilizes Kafka as the messaging queue so if one microservice goes down, it will receive messages when it gets back up.

Prerequisites

• Install Node.js

• Install Apache Kafka or run it in a docker container (How to)

Installing

• Clone the repository

git clone https://github.com/19EB/microservices-base

• Install dependencies on api-gateway

cd api-gateway

npm install

• Install dependencies on each microservice (user, product and client)

cd services/<microservice>

npm install

Environment variables

This project uses the following environment variables:

api-gateway

# Port
PORT=8000

# User service
USER_SERVICE_URL='http://localhost:8001'

# Client service
CLIENT_SERVICE_URL='http://localhost:8002'

# Product service
PRODUCT_SERVICE_URL='http://localhost:8003'

microservice

# Database
DB=''

# Service port
PORT=8001

# Apache Kafka configuration
KAFKA_BROKER='localhost:29092'

Running the project

• If you plan on using Docker for running Kafka, I have included "kafka" folder that contains the docker-compose file with zookeeper and kafka.

cd kafka
docker-compose up -d

• Start each microservice from its own directory

Development mode

cd services/<microservice>

npm run dev

Production mode

cd services/<microservice>

npm start

• Start the api-gateway

cd api-gateway

npm start

or

npm run dev

Navigate to http://localhost:8000

Endpoints

The project has couple endpoints to ping each other and one normal endpoint.

http://localhost:8000/user/list

http://localhost:8000/user/ping-client

http://localhost:8000/user/ping-product

http://localhost:8000/client/list

http://localhost:8000/client/ping-user

http://localhost:8000/client/ping-product

http://localhost:8000/product/list

http://localhost:8000/product/ping-user

http://localhost:8000/product/ping-client

License

This project is licensed under the MIT License