███████╗     ██████╗  ██████╗ ███╗   ███╗███╗   ███╗███████╗██████╗  ██████╗███████╗
██╔════╝    ██╔════╝ ██╔═══██╗████╗ ████║████╗ ████║██╔════╝██╔══██╗██╔════╝██╔════╝
█████╗█████╗██║  ███╗██║   ██║██╔████╔██║██╔████╔██║█████╗  ██████╔╝██║     █████╗  
██╔══╝╚════╝██║   ██║██║   ██║██║╚██╔╝██║██║╚██╔╝██║██╔══╝  ██╔══██╗██║     ██╔══╝  
███████╗    ╚██████╔╝╚██████╔╝██║ ╚═╝ ██║██║ ╚═╝ ██║███████╗██║  ██║╚██████╗███████╗
╚══════╝     ╚═════╝  ╚═════╝ ╚═╝     ╚═╝╚═╝     ╚═╝╚══════╝╚═╝  ╚═╝ ╚═════╝╚══════╝

Overview

This is a personal project that simulates an e-commerce service that I want to publish in the future as a real-world product :) It uses Go (Golang), and includes a variety of services, each serving a specific purpose, and a front-end application to interact with these services. It also uses kubernetes to simulate a production environment locally.

Project Structure

• front-end: The front-end application for interacting with the microservices.
• broker-service: Acts as an API Gateway, routing requests to the appropriate services.
• project: Contains configuration files and scripts for Docker, Makefile, Caddy, and Kubernetes (k8s).
• authentication-service: Manages user authentication and authorization.
• logger-service: Handles logging of application data and events.
• mail-service: Manages sending emails and notifications.
• listener-service: Listens to events and messages from other services, performing actions accordingly.
• product-service: Manages product-related operations and data storage.

Technologies Used

• Go (Golang): The primary programming language used to write the services.
• Docker: For containerizing the application and services.
• Kubernetes (k8s): For orchestrating and managing the containers.
• RabbitMQ: For message queuing and event-driven architecture.
• MongoDB: Used by the logger service for storing logs.
• PostgreSQL: For database operations in the authentication and product services.
• Caddy: As a web server and for handling HTTPS.

Requirements/dependencies

• Docker
• docker-compose (more info: https://docs.docker.com/compose/)
• minikube (more info: https://github.com/kubernetes/minikube)
• kubectl (install instructions: https://kubernetes.io/docs/tasks/tools/)

Virtual hosts configuration

As the project emulates the front and backend, it's necessary to virtualize one or both of the hosts to run locally. In the project/ingress.yml configuration file I've defined the domains: front-end.info and broker-service.info you can change it as you like. Before starting the application, you have to add your hosts in your configuration hosts files. On MacOS the file is in /etc/hosts and you can edit it including the following line:

127.0.0.1 front-end.info broker-service.info

For other OS, please follow this tutorial: https://www.manageengine.com/network-monitoring/how-to/how-to-add-static-entry.html

Getting Started

1. Clone the repository:

   git clone https://github.com/jhonipereira/eGommerce.git

2. If you use VS Code, open the file workspace.code-workspace directly from the file explorer to open the structure with workspaces. Follow the setup instructions in the project directory to configure Docker, Kubernetes, and other dependencies.

3. In the project folder, start the PostgreSQL database:

   docker-compose -f postgres.yml up -d

4. Create one or more instance with minikube:

minikube start --nodes=N

Where N is the number of nodes to start. The default value is 1

5. Install all K8s: this will create all the resources in a cluster

kubectl apply -f k8s

6. Make a tunnel for local access: this will create a route to services deployed with LoadBalancer and set the Ingress to the ClusterIP. This command will be active until you cancel it with CTRL+C

minikube tunnel

API Requests

Broker Service

Endpoint	HTTP Method	Description
/	POST	Root endpoint
/log-grpc	POST	Log item via gRPC
/handle	POST	API Gateway

Authentication Service

Endpoint	HTTP Method	Description
/authenticate	POST	User login

Logger Service

Endpoint	HTTP Method	Description
/log	POST	Write log

Mail Service

Endpoint	HTTP Method	Description
/send	POST	Send mail

Product Service

Endpoint	HTTP Method	Description
/products/	GET	Get all products
/products/{name}	GET	Get product by name
/products/{id:[0-9]+}	GET	Get product by ID
/products/	PUT	Update product
/products/{id:[0-9]+}	DELETE	Delete product by ID
/products/	POST	Insert product

Test the broker endpoints API using curl

1. Root Endpoint

Endpoint	HTTP Method	Description
/	POST	Root endpoint

Request

curl -i --request POST 'http://your-domain.com/' 

Response

{
  "Error": false,
  "Message": "Hit the broker"
}

2. Log Item via gRPC

Endpoint	HTTP Method	Description
/log-grpc	POST	Log item via gRPC

Request

curl -i --request POST 'http://your-domain.com/log-grpc'

Response

{
  "Error": false,
  "Message": "logged"
}

3. Handle Submission

This is the main endpoint serving as an API Gateway for the entire service. It can receive and return multiple types of data. The response of the request depends on the action that has been passed. e.g.: if the request action is "log", the response object is "log".

Endpoint	HTTP Method	Description
/handle	POST	API Gateway

Request

curl -i --request POST 'http://your-domain.com/handle' \
--header 'Content-Type: application/json' \
--data-raw '{
  "action": "log / auth / mail / product",
  "auth": {
    "email": "[email protected]",
    "password": "123456"
  },
  "log": {
    "name": "user name",
    "data": "some data"
  },
  "mail": {
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "some subject",
    "message": "the body of the email"
  },
  "product": {
    "name": "Product name",
    "description": "product description",
    "photos": "[url-to-photo]"
  },
}'

Response

{
  "error": false,
  "message": "message refering the action",
  "data": "log/mail/auth/product objects"
}

Contributing

Contributions to the project are welcome. Please follow the contribution guidelines for more information.

License

This project is licensed under the MIT License.

Contact

For any inquiries or issues, please open an issue on the GitHub repository.