https://github.com/joakimteixeira/loyalty-as-a-service

Distributed, automated and highly scalable supermarket chain management system
https://github.com/joakimteixeira/loyalty-as-a-service

aws-ec2 aws-rds aws-s3 bpmn camunda curl docker dockerhub java kafka kong konga load-balancer maven microservices-architecture mysql postman quarkus shell-script terraform

Last synced: 11 days ago
JSON representation

Distributed, automated and highly scalable supermarket chain management system

• Host: GitHub
• URL: https://github.com/joakimteixeira/loyalty-as-a-service
• Owner: JoakimTeixeira
• License: mit
• Created: 2024-05-20T02:28:49.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-10-10T21:13:16.000Z (3 months ago)
• Last Synced: 2024-11-02T11:21:58.662Z (about 2 months ago)
• Topics: aws-ec2, aws-rds, aws-s3, bpmn, camunda, curl, docker, dockerhub, java, kafka, kong, konga, load-balancer, maven, microservices-architecture, mysql, postman, quarkus, shell-script, terraform
• Language: HTML
• Homepage:
• Size: 19.7 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Loyalty-as-a-Service (LaaS)

Distributed, automated, and highly scalable supermarket chain management system

## Running the Project

To get started:

1.  Fork the repository, clone it, and add your AWS and Docker credentials to the environment variables in the `Access.sh` file.

2.  This project uses docker to containerize the Quarkus microservices, so log into your docker account with the command:

          docker login

    Or use the `Docker Desktop` application in your operational system

3.  Then run the following command to provision the AWS resources:

          source ./scripts/terraform/DeploymentAutomation-ubuntu.sh

    To destroy all resources, run the command:

          source ./scripts/terraform/UndeploymentAutomation.sh

    If you want to remove all your credentials from the project, run the command:

          source ./scripts/auth/CleanProject.sh

4.  Camunda is responsible for orchestrating the business logic of the application. To deploy the Camunda BPMN files, open the Camunda Modeler program and enter this URL as the deployment URL:

            http://:8080/engine-rest/deployment/create

## To-do

- [x] Implement Postman scripts for E2E tests of BPMN diagrams

- [x] Model BPMN diagrams for new microservices

- [x] Adapt BPMN diagrams Camunda and microservices communicate through Kong endpoints

- [x] Automate EC2 URL replacement in BPMN diagrams (XML files) and Postman script

- [x] Automate Kong routes and servers creation

- [x] Automate Kong and Konga configuration on docker images

- [x] Automate Konga UI to initiate with custom admin user + Kong connection

- [x] Create Kong scripts to serve as API Gateway for the microservices

- [x] Automate AWS key pairs provisioning

- [x] Implement the "sold product" microservice

- [x] Configure terraform state to be backed up in AWS S3

- [x] Make the terraform state detect changes when the Quarkus docker image is created

- [x] Remove Quarkus docker images from the local machine and Docker Hub

- [x] Avoid creating Kong services and routes again if they already exist

- [x] Integrate an RDS database into each microservice to decrease coupling

- [ ] Update replacement script (sed) to leverage multiple Kafka instances in the same machine

- [ ] Replace Java/Kafka microservice modules to use Node.js + [KafkaJS](https://github.com/tulios/kafkajs)

- [ ] Create new logic for BPMN diagrams in Camunda

- [ ] Improve the database architecture

- [ ] Implement web interface to interact with microservices

- [ ] Migrate deprecated [Konga GUI](https://github.com/pantsel/konga) to [Primate GUI](https://github.com/getprimate/primate)

- [ ] Document architecture