Real Notification is a robust and scalable notification service designed to deliver reliable performance. This project leverages a powerful tech stack, including Apache Kafka for efficient message queuing, Postgres for persistent storage of notifications, and Gin as a framework for handling incoming requests.
-
Utilize Apache Kafka as a robust messaging queue for efficient handling of heavy messages.
-
Employ Docker Compose for a comprehensive project setup.
-
Ensure swift response times with the lightweight Gin framework.
-
Implement an IP-based rate limiter to prevent spam requests.
-
Organize API endpoints using an MVC architecture.
-
Embrace a microservices architecture for all services.
-
Conducted load testing using k6.
-
Implement a CRON job to identify and resend failed notifications.
-
Integrated Redis Cache for checking repeated Notifications
-
Used Database sharding for saving the notifications
-
Used my LoadBalancer Project for handling traffic
To get started with Real Notification, follow these steps:
-
Clone the Repository:
git clone [repository_url] -
Build Docker Containers: Navigate to the project directory and run
docker-compose up --buildto set up the Docker containers for the database and the application. -
Configure the System: Adjust configuration files as needed, specifying connection details for Apache Kafka and Postgres.
-
Run the Application: Start the application using
go run main.goor as per your preferred deployment method.
- Before spinning up Prometheus & Grafana for monitoring, replace the HOST_IP variable (under monitoring/prometheus/config.yml) with your machine IP.
- Run the command
docker-compose upinside the monitoring folder - Once the containers - Prometheus & Grafana are up, visit http://localhost:3000 on browser for Grafana dashboard.
Default credentials for Grafana: username - 'admin' , password - 'admin'
Once logged into Grafana, visit settings to select prometheus data source as target to view the dashboard.
We welcome contributions in the form of bug reports, feature requests, or pull requests.
Real Notification is licensed under the MIT License. Feel free to use, modify, and distribute the code as per the terms of the license.