https://github.com/raj3k/rgb-to-grayscale-microservices

https://github.com/raj3k/rgb-to-grayscale-microservices

Last synced: 28 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/raj3k/rgb-to-grayscale-microservices
• Owner: raj3k
• Created: 2023-01-10T12:29:27.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T22:13:51.000Z (about 1 year ago)
• Last Synced: 2024-10-16T19:30:09.156Z (3 months ago)
• Language: TypeScript
• Size: 828 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Convert RGB Image to Grayscale Image (Microservices)

## Project Description

Simple application responsbile for converting RGB images to grayscale. Main goal or objective for this project was to build somehow real world project 

and learn something about Microservices architecture. The system design is heavily inspired by FreeCodeCamp tutorial: 

https://www.youtube.com/watch?v=hmkF77F9TLw&list=PLHzzSkMFgDo8rg9m4n64OTzszpsmziGDd&index=1&ab_channel=freeCodeCamp.org. 

I've added very simple client service (used React for that) and changed notification service - instead of sending notification email to user, 

I've decided to use Server Send Events to inform user that image is converted and ready to download. Below is a system design diagram:

![diagram](./system-diagram.png)

## Technologies used



  
TypeScript - used for every service except Converter. Mainly because I'm learning it and simply enjoy working with TS

  
Python - used for Converter Service because of PIL (Python Image Library)

  
RabbitMQ - message queue, for this simple project RabbitMQ is more suitable than Kafka (https://www.simplilearn.com/kafka-vs-rabbitmq-article#what_is_kafka_used_for)

  
Docker/docker-compose

  
Mongo (GridFS) - I'm storing only small images (<8MB) so in this case Mongo's GridFS is slightly faster than AWS S3 (https://simonjcarr.medium.com/mongodb-gridfs-vs-s3-storage-f5ba1ebcc490) 

  
MySQL - for keeping user data

  
Server Send Event - I didn't want to use SMTP so notification service is consuming messages from queue and sends event to client service

  
Nginx - reverse proxy



## How to install/run project



  
Clone repo

  
Run docker compose command in project directory: docker-compose -f docker-compose.dev.yaml up -d (TODO: notification service starts before RabbitMQ and throws error, for now Notification Service needs to be restarted manually)





## TODO

- [ ] use Kubernetes for orchestration

- [ ] deploy to AWS?

- [ ] add video displaying usage of the application