Siva | Add CHANGELOG and enhance README with project features and setup instructions

Author: ysskrishna

CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2025-04-25
+
+### Added
+- **Distributed Messaging System**
+  - Implemented FastAPI for RESTful API endpoints
+  - Integrated RabbitMQ as message broker with management interface
+  - Set up Celery for background task processing
+  - Added Flower dashboard for real-time task monitoring
+  - Configured PostgreSQL for message persistence
+
+- **Notification Services**
+  - Integrated Twilio API for SMS notifications
+  - Integrated Brevo (formerly Sendinblue) for email notifications
+  - Implemented separate queues for SMS and email tasks
+  - Added idempotency key generation for message deduplication
+
+- **Infrastructure & Configuration**
+  - Containerized application using Docker and docker-compose
+  - Implemented health checks for all services
+  - Added environment-based configuration for web and worker components
+  - Set up Poetry for dependency management
+  - Configured separate virtual environments for web and worker
+
+- **API Features**
+  - Added Swagger UI documentation at `/docs`
+  - Implemented RESTful endpoints for notifications
+  - Added root endpoint health check
+
+- **Worker Configuration**
+  - Configured worker concurrency (2 workers)
+  - Implemented task acknowledgment after processing
+  - Added task requeuing on worker failure
+  - Set up result backend with PostgreSQL
+
+- **Monitoring & Management**
+  - RabbitMQ Management UI (port 15672)
+  - Flower monitoring dashboard (port 5555)
+  - Database health monitoring
+  - Service dependency management
+
+
+[1.0.0]: https://github.com/ysskrishna/fastapi-rabbitmq-celery-flower/releases/tag/v1.0.0

README.md

@@ -1,38 +1,84 @@
+# FastAPI RabbitMQ Celery Flower Application
 
-## Docker commands
+A distributed application for sending SMS and emails using FastAPI, RabbitMQ, Celery, Flower and PostgreSQL.
 
-**start all containers**
-```
+### Features
+- **Distributed Messaging System**: Implemented a robust architecture for message processing using FastAPI, RabbitMQ, Celery, and PostgreSQL
+- **SMS Notifications**: Integration with Twilio API for sending SMS messages
+- **Email Notifications**: Integration with Brevo (formerly Sendinblue) for sending transactional emails
+- **Message Queuing**: Separate queues for SMS and email tasks to optimize message processing
+- **Database Persistence**: PostgreSQL integration for storing and tracking message status
+- **Containerization**: Full Docker support with docker-compose for easy deployment
+- **Real-time Monitoring**: Flower dashboard for monitoring Celery workers and task execution
+- **API Documentation**: Swagger UI for easy API testing and documentation
+
+### Technical Highlights
+- **FastAPI Web Server**: RESTful API endpoints for triggering notifications
+- **Celery Workers**: Background task processing for non-blocking operations
+- **RabbitMQ Message Broker**: Reliable message queuing with management interface
+- **Health Checks**: Service health monitoring for all components
+- **Environment Configuration**: Separate environment configurations for web and worker components
+- **Dependency Management**: Poetry for Python dependency management
+
+### Infrastructure
+- **Database**: PostgreSQL 14
+- **Message Broker**: RabbitMQ 3 with Management Plugin
+- **Monitoring**: Celery Flower dashboard with authentication
+- **Service Orchestration**: Docker Compose with health checks and dependency management 
+
+## Setup and Run
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/ysskrishna/fastapi-rabbitmq-celery-flower
+   cd fastapi-rabbitmq-celery-flower
+   ```
+
+2. Update environment variables:
+
+   **For webserver/.env:**
+   ```
+   TWILIO_FROM_PHONE="your-twilio-phone-number"
+   BREVO_FROM_EMAIL="your-brevo-from-email" 
+   ```
+
+   **For worker/.env:**
+   ```
+   TWILIO_ACCOUNT_SID="your-twilio-account-sid"
+   TWILIO_AUTH_TOKEN="your-twilio-auth-token"
+   BREVO_API_KEY="your-brevo-api-key"
+   ```
+
+3. Run the application using Docker Compose:
+   ```bash
+   docker-compose up -d
+   ```
+
+4. Access the application:
+   - Swagger API documentation: `http://localhost:8000/docs`
+   - RabbitMQ Management UI: `http://localhost:15672/` (Username: admin_user, Password: admin_pass)
+   - Flower dashboard: `http://localhost:5555/` (Username: admin, Password: supersecret)
+
+## Development
+
+To modify the application:
+
+1. Update code in the `webserver` or `worker` directories
+2. Restart the containers:
+   ```bash
+   docker-compose down
+   docker-compose up -d
+   ```
+
+## Docker Commands
+
+```bash
+# Start all containers
 docker compose up --build
-```
 
-**stop all containers**
-```
+# Stop all containers
 docker compose down
-```
 
-**stop and delete volumes**
-```
+# Stop and delete volumes
 docker compose down -v
-```
-
-**Fastapi swagger documentation**
-```
-http://localhost:8000/docs
-```
-
-**Rabbitmq Dashboard**
-```
-http://localhost:15672/
-```
-
-**Flower dashboard**
-```
-http://localhost:5555/
-```
-
-**update webserver/.env variables**
-```
-TWILIO_FROM_PHONE="your-twilio-phone-number"
-BREVO_FROM_EMAIL="your-brevo-from-email" 
 ```