How vsuraj25/microservices-demo-app works
Project type and purpose
• This is a full-stack microservices demo application. It comprises three primary services (React frontend, Django admin, Flask API) that communicate via RabbitMQ and share a MySQL database. Docker Compose is used to spin up containers for each component.
File structure
• Top-level directories:
• admin/ – Django admin service
• main/ – Flask API service (contains main.py, producer.py, consumer.py, migrations/, requirements.txt, Dockerfile, docker-compose.yml, and a MySQL data volume under .dbdata/)
• react-app/ – React frontend (likely in react-crud subfolder)
• Under main/:
• migrations/ – Alembic migration scripts for schema versioning
• .dbdata/ – MySQL data directory (volume)
• producer.py, consumer.py, manager.py – RabbitMQ producers/consumers for async events
• Dockerfile & docker-compose.yml – service container definitions and orchestration
README for additional insights
• Architectural call-out: React UI, Django Admin (port 8000), Flask API (port 8001), RabbitMQ, MySQL, Docker.
• Features: CRUD on products, REST endpoints, event-driven via RabbitMQ.
• Technologies: React/TypeScript, Django, Flask, Python, RabbitMQ, MySQL, Docker.
a. Main components
• Browser/React App (port 3000)
• Django Admin Service (container, port 8000)
• Flask API Service (container, port 8001)
• RabbitMQ Broker (container, ports 5672 & 15672)
• MySQL Database (container, data volume at main/.dbdata)
• Worker(s) – the consumer.py process that subscribes to product events
b. Relationships & data flows
• React → HTTP → Flask API (CRUD REST calls)
• React → HTTP → Django Admin (admin API calls)
• Flask API → MySQL (sync DB reads/writes)
• Django Admin → MySQL (sync DB reads/writes)
• Flask API (producer.py) → AMQP → RabbitMQ
• Worker (consumer.py) ← AMQP ← RabbitMQ
c. Architectural patterns & design principles
• Microservices: each service in its own container
• Layered: UI layer (React), API layer (Flask & Django), persistence (MySQL), messaging layer (RabbitMQ)
• Event-driven: product create/update/delete events go through a message broker
• Infrastructure as code: Dockerfiles + docker-compose.yml define the entire environment
d. Key technologies/frameworks
• Frontend: React, TypeScript
• Admin backend: Django
• Main API: Flask, Python, Alembic for migrations
• Messaging: RabbitMQ
• Database: MySQL (persistent volume under main/.dbdata)
• Orchestration: Docker Compose