Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoangsonww/budget-management-backend-api
🚀 Dive into the world of Node.js, MongoDB, Redis, Postgres, RabbitMQ, ELK stack, and more with this comprehensive sample backend API project! Explore how these powerful technologies can be integrated to build robust, scalable, and efficient backend solutions.
https://github.com/hoangsonww/budget-management-backend-api
elasticsearch elk-stack express gprc grafana graphql kibana logstash mongo mongodb mongodb-database nginx nodejs postgres postgresql prometheus rabbitmq redis redis-cache rest-api
Last synced: 9 days ago
JSON representation
🚀 Dive into the world of Node.js, MongoDB, Redis, Postgres, RabbitMQ, ELK stack, and more with this comprehensive sample backend API project! Explore how these powerful technologies can be integrated to build robust, scalable, and efficient backend solutions.
- Host: GitHub
- URL: https://github.com/hoangsonww/budget-management-backend-api
- Owner: hoangsonww
- License: mit
- Created: 2024-06-23T13:18:43.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-12-19T07:54:35.000Z (9 days ago)
- Last Synced: 2024-12-19T08:33:28.326Z (9 days ago)
- Topics: elasticsearch, elk-stack, express, gprc, grafana, graphql, kibana, logstash, mongo, mongodb, mongodb-database, nginx, nodejs, postgres, postgresql, prometheus, rabbitmq, redis, redis-cache, rest-api
- Language: JavaScript
- Homepage: https://hoangsonww.github.io/Budget-Management-Backend-API/
- Size: 1.51 MB
- Stars: 15
- Watchers: 13
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **Budget Management Backend API**
Welcome to the **Budget Management API**, a robust backend application designed to manage budgets, expenses, users, orders, notifications, and more. This API integrates cutting-edge technologies and supports advanced features like gRPC, GraphQL, WebSockets, Elasticsearch, PostgreSQL, MySQL, Redis, RabbitMQ, Kafka, and Docker.
Moreover, it also includes a CLI tool for interacting with the backend and a comprehensive Swagger documentation for testing and exploring the API.
Below is a comprehensive guide to setting up, running, and utilizing this API.
## **Table of Contents**
1. [Overview](#overview)
2. [Live Deployment](#live-deployment)
3. [Technologies Used](#technologies-used)
4. [Project Structure](#project-structure)
5. [Setup Instructions](#setup-instructions)
6. [Available Endpoints](#available-endpoints)
7. [Schemas](#schemas)
8. [Features and Integrations](#features-and-integrations)
9. [Environment Variables](#environment-variables)
10. [CLI Usage](#cli-usage)
11. [Swagger Documentation](#swagger-documentation)
12. [GraphQL Integration](#graphql-integration)
13. [NGINX Configuration](#nginx-configuration)
14. [gRPC Integration](#grpc-integration)
15. [Dockerization](#dockerization)
16. [Kubernetes Deployment](#kubernetes-deployment)
17. [Continuous Integration and Deployment with Jenkins](#continuous-integration-and-deployment-with-jenkins)
18. [Testing](#testing)
19. [Contributing](#contributing)
20. [Author](#author)
## **Overview**
The Budget Management API is designed to handle complex budget management requirements, including:
- Budget and expense tracking.
- User management and authentication.
- Real-time notifications via WebSockets.
- Asynchronous task handling using RabbitMQ and Kafka.
- Advanced search capabilities with Elasticsearch.
- CLI operations for direct interaction with the system.
- Compatibility with modern cloud environments like Docker and Kubernetes.
The purpose of this API is to demonstrate the capabilities of modern backend technologies and provide a foundation for building scalable, real-time applications. It can be used as a reference for developers looking to implement similar features in their projects. Simply clone the repository, set up the environment, and start building the frontend or additional functionality on top of the existing API!
## **Live Deployment**
The Budget Management API is deployed live at [https://budget-management-backend-api.onrender.com](https://budget-management-backend-api.onrender.com).
You can access the API and test the endpoints directly from the browser. Feel free to use the API for your own projects or applications. Simply add some attribution to the original repository and the creator. Also, be sure that you use your own credentials and tokens, otherwise your data may clash with mine and other users' data!
> Note: Be mindful of the rate limits and usage policies when testing the live API. Additionally, because the API is hosted on the free plan of Render, it may take a while (1-2 minutes) to wake up if it has been inactive for some time. Kindly be patient during this process!
### Deployment and Technology Status
[](https://budget-management-backend-api.onrender.com)
[](https://www.mongodb.com/)
[](https://redis.io/)
[](https://www.postgresql.org/)
[](https://www.rabbitmq.com/)
[](https://kafka.apache.org/)
[](https://www.elastic.co/elasticsearch/)
[](https://grpc.io/)
[](https://graphql.org/)
[](https://budget-management-backend-api.onrender.com/docs)
[](https://www.docker.com/)
[](https://kubernetes.io/)
[](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API)
[](https://www.nginx.com/)
[](https://www.openapis.org/)
[](https://www.jenkins.io/)
[](https://prometheus.io/)
[](https://grafana.com/)
[](https://nodejs.org/)
[](https://expressjs.com/)
## **Technologies Used**
| **Technology** | **Purpose** |
|---------------------|-----------------------------------------------------------|
| **Node.js** | Core application framework. |
| **Express.js** | Web application framework for building APIs. |
| **MongoDB** | Primary NoSQL database for managing budgets and expenses. |
| **PostgreSQL** | Relational database for transaction logs. |
| **MySQL** | Optional relational database support. |
| **Redis** | In-memory database for caching. |
| **RabbitMQ** | Message broker for task queuing. |
| **Kafka** | Distributed event streaming platform. |
| **Elasticsearch** | Advanced search engine for querying data. |
| **gRPC** | High-performance remote procedure call framework. |
| **GraphQL** | Query language for fetching and manipulating data. |
| **WebSocket** | Real-time communication for notifications. |
| **Swagger/OpenAPI** | API documentation and testing. |
| **Docker** | Containerization for easy deployment. |
| **Kubernetes** | Orchestrating containerized applications at scale. |
| **Nginx** | Reverse proxy and load balancer. |
| **Prometheus** | Monitoring and alerting toolkit. |
| **Grafana** | Observability and visualization platform. |
| **Jenkins** | CI/CD pipeline for automated testing and deployment. |
## **Project Structure**
```plaintext
Budget-Management-Backend-API/
├── .env # Environment variables configuration
├── .env.example # Example environment configuration file
├── .gitignore # Git ignore file
├── .prettierrc # Prettier configuration for code formatting
├── LICENSE # License information
├── README.md # Documentation for the project
├── app.test.js # Main test file for application
├── cli.js # CLI tool for interacting with the backend
├── docker-compose.yml # Docker Compose configuration
├── Dockerfile # Dockerfile for containerizing the application
├── grpcServer.js # gRPC server implementation
├── index.js # Main entry point for the application
├── nodemon.json # Nodemon configuration file
├── openapi.yaml # OpenAPI specification for the API
├── package.json # NPM package configuration file
├── start.sh # Script to start the application
├── prometheus.yml # Prometheus configuration for monitoring
├── redis-mongo-flow/ # Directory for Redis-Mongo integration flow
│ ├── app.js # Express app for Redis-Mongo flow
│ ├── config.js # Configuration for Redis-Mongo flow
│ ├── package.json # NPM configuration for this module
│ ├── README.md # Documentation specific to Redis-Mongo flow
│ ├── seed.js # Data seeder for Redis-Mongo flow
│ ├── test.js # Test file for Redis-Mongo flow
├── round-robin/ # Directory for round-robin load balancer
│ ├── config.js # Configuration for round-robin implementation
│ ├── index.js # Main entry point for round-robin logic
│ ├── README.md # Documentation for round-robin functionality
├── proto/ # Protocol Buffers directory
│ ├── budget.proto # gRPC proto file for budgets
├── nginx/ # NGINX configuration directory
│ ├── docker-compose.yml # Docker Compose for NGINX
│ ├── Dockerfile # Dockerfile for NGINX
│ ├── nginx.conf # NGINX configuration file
│ ├── start_nginx.sh # Script to start NGINX
│ ├── README.md # Documentation for NGINX
├── docs/ # Documentation directory
│ ├── swaggerConfig.js # Swagger configuration for API docs
├── graphql/ # GraphQL-related files
│ ├── schema.js # GraphQL schema definition
├── services/ # Services and utilities
│ ├── dataSeeder.js # Seeder for MongoDB
│ ├── elasticService.js # Elasticsearch client and utility functions
│ ├── jwtService.js # JSON Web Token (JWT) utilities
│ ├── postgresService.js # PostgreSQL client and utilities
│ ├── rabbitMQService.js # RabbitMQ client and utilities
│ ├── redisService.js # Redis client and utilities
│ ├── websocketService.js # WebSocket server and utilities
├── controllers/ # Route controllers for the API
│ ├── authController.js # Authentication-related endpoints
│ ├── budgetController.js # Budget management endpoints
│ ├── customerController.js # Customer management endpoints
│ ├── expenseController.js # Expense management endpoints
│ ├── notificationController.js # Notification management endpoints
│ ├── orderController.js # Order management endpoints
│ ├── searchController.js # Search-related endpoints
│ ├── taskController.js # Task management endpoints
│ ├── transactionController.js # Transaction log endpoints
│ ├── userController.js # User profile management endpoints
├── middleware/ # Middleware utilities
│ ├── authMiddleware.js # JWT authentication middleware
├── models/ # Mongoose schemas
│ ├── budget.js # Schema for budgets
│ ├── customer.js # Schema for customers
│ ├── expense.js # Schema for expenses
│ ├── order.js # Schema for orders
│ ├── task.js # Schema for tasks
│ ├── user.js # Schema for users
├── routes/ # Express router files
│ ├── authRoutes.js # Routes for authentication
│ ├── budgetRoutes.js # Routes for budgets
│ ├── customerRoutes.js # Routes for customers
│ ├── expenseRoutes.js # Routes for expenses
│ ├── graphqlRoutes.js # Routes for GraphQL
│ ├── index.js # Main router entry point
│ ├── notificationRoutes.js # Routes for notifications
│ ├── orderRoutes.js # Routes for orders
│ ├── searchRoutes.js # Routes for Elasticsearch
│ ├── taskRoutes.js # Routes for tasks
│ ├── transactionRoutes.js # Routes for transactions
│ ├── userRoutes.js # Routes for user profiles
├── views/ # Static assets and templates
│ ├── android-chrome-192x192.png # Android Chrome app icon
│ ├── android-chrome-512x512.png # Android Chrome high-res icon
│ ├── apple-touch-icon.png # Apple Touch icon
│ ├── favicon.ico # Favicon
│ ├── favicon-16x16.png # 16x16 favicon
│ ├── favicon-32x32.png # 32x32 favicon
│ ├── home.html # HTML template for homepage
│ ├── manifest.json # Web app manifest
```
## **Setup Instructions**
### Prerequisites
- Node.js (>= 16)
- Docker and Docker Compose (if using containerized setup)
- MongoDB, PostgreSQL, MySQL, RabbitMQ, Redis, and Elasticsearch services.
### Local Installation
1. Clone the repository:
```bash
git clone https://github.com/hoangsonww/Budget-Management-Backend-API.git
cd Budget-Management-Backend-API
```
2. Install dependencies:
```bash
npm install
```
3. Set up environment variables:
- Create a `.env` file in the root directory:
```env
MONGO_DB_URI=mongodb://localhost:27017/budget_manager
POSTGRES_URI=postgres://user:password@localhost:5432/budget_manager
REDIS_URL=redis://localhost:6379
RABBITMQ_URL=amqp://localhost
KAFKA_BROKER=localhost:9092
JWT_SECRET=your_secret_key
```
- Replace placeholders with your actual configuration.
4. Start the application:
```bash
npm start
```
5. Access the application:
- API: `http://localhost:3000`
- Swagger: `http://localhost:3000/docs`
## **Available Endpoints**
| **Endpoint** | **Method** | **Description** |
|------------------------|------------|------------------------------------------|
| `/api/auth/register` | POST | Register a new user. |
| `/api/auth/login` | POST | Login and receive a JWT token. |
| `/api/users/profile` | GET | Get the authenticated user's profile. |
| `/api/budgets` | GET | Get all budgets. |
| `/api/budgets` | POST | Create a new budget. |
| `/api/expenses` | GET | Get all expenses. |
| `/api/expenses` | POST | Add a new expense. |
| `/api/orders` | GET | Get all orders. |
| `/api/orders` | POST | Create a new order. |
| `/api/graphql` | POST | Perform a GraphQL query. |
| `/api/notifications` | POST | Send a real-time notification. |
| `/api/search/expenses` | POST | Search for expenses using Elasticsearch. |
Additionally, the root `/` endpoint provides a welcome message and information about the API.
More endpoints and features are available in the API. Refer to the [Swagger documentation](https://budget-management-backend-api.onrender.com/docs) for detailed information.
## **Schemas**
### **User**
| **Field** | **Type** | **Description** |
|-------------|----------|-----------------------------|
| `username` | String | Unique username. |
| `email` | String | Unique email address. |
| `password` | String | Hashed password. |
### **Budget**
| **Field** | **Type** | **Description** |
|-------------|----------|-----------------------------|
| `name` | String | Budget name. |
| `limit` | Number | Budget limit. |
### **Expense**
| **Field** | **Type** | **Description** |
|------------|----------|------------------------------|
| `budgetId` | String | ID of the associated budget. |
| `amount` | Number | Expense amount. |
## **Features and Integrations**
### **gRPC**
- High-performance RPC framework.
- Start the gRPC server using:
```bash
npm start
```
### **GraphQL**
- Flexible data queries and mutations.
- Access the GraphQL endpoint at `http://localhost:3000/graphql`.
### **WebSocket**
- Real-time notifications for clients.
- Notifications can be sent using the `/api/notifications` endpoint or CLI.
### **Docker**
- Build and run the app with Docker:
```bash
docker-compose up --build
```
### **Elasticsearch**
- Advanced search for expenses.
- Search endpoint: `/api/search/expenses`.
### **RabbitMQ**
- Asynchronous task handling.
- Use the `budget-manager` CLI to add tasks.
- Tasks are processed in the background.
### **Kafka**
- Distributed event streaming platform.
- Kafka broker URL: `localhost:9092`.
- Kafka producer and consumer are integrated.
### **Redis**
- In-memory caching for improved performance.
- Redis URL: `redis://localhost:6379`.
- Caching is used for user sessions and other data.
### **PostgreSQL**
- Relational database for transaction logs.
- PostgreSQL URL: `postgres://user:password@localhost:5432/budget_manager`.
- Used for storing transaction logs and other relational data.
- MySQL is also supported as an alternative.
### **MongoDB**
- Primary NoSQL database for managing budgets and expenses.
- MongoDB URL: `mongodb://localhost:27017/budget_manager`.
- Used for storing budgets, expenses, and user data.
### **Nginx**
- Reverse proxy and load balancer.
- Nginx configuration is included in the `nginx` directory.
- Load balancing can be configured for multiple instances.
- SSL termination and caching can be added.
### **Kubernetes**
- Deployment manifests are available in the `kubernetes` directory.
- Deploy the application to a Kubernetes cluster using:
```bash
kubectl apply -f kubernetes/
```
### **Prometheus and Grafana**
- Monitoring and observability tools.
- Prometheus configuration is available in `prometheus.yml`.
- Grafana can be used for visualization and monitoring.
- Metrics and dashboards can be configured.
- Monitor the health and performance of the API.
## **Services Interaction**
The Budget Management API interacts with various services and databases to provide a comprehensive backend solution. The architecture includes a frontend UI, a CLI tool, an API gateway, a gRPC server, and multiple external services. Here is a high-level overview of the service interaction:
```plaintext
+--------------------+ +------------------+
| Frontend UI | | |
| (not impl.) | | CLI Tool / gRPC |
+--------------------+ +------------------+
| |
| HTTP/GraphQL Requests | CLI Commands / gRPC Calls
| |
+--------------------+ +------------------+
| API Gateway / |<--------------->| gRPC Server |
| Express.js | +------------------+
+--------------------+
|
| RESTful API / WebSocket / GraphQL Responses
|
+--------------------+
| Application Core |
|--------------------|
| Controllers / |
| Services |
+--------------------+
| | |
+------+ | +-------------+
| | |
+----------+ +-----------+ +----------------+
| MongoDB | | PostgreSQL | | Elasticsearch |
| NoSQL DB | | Relational | | Search Engine |
+----------+ +-----------+ +----------------+
| | |
| | |
+----------+ +-------------+ +----------------+
| Redis | | RabbitMQ / | | Kafka (Event |
| Cache | | Kafka Queue | | Streaming) |
+----------+ +-------------+ +----------------+
|
| (Asynchronous Tasks)
|
+----------------------+
| External Services |
| (Email, SMS, etc.) |
+----------------------+
```
## **Environment Variables**
Ensure your `.env` file looks like this before getting started:
```env
# Server Configuration
PORT=
# MongoDB Configuration
MONGO_DB_URI=
MONGO_DB_USERNAME=
MONGO_DB_PASSWORD=
# Redis Configuration
REDIS_HOST=
REDIS_PORT=
REDIS_URL=
# RabbitMQ Configuration
RABBIT_MQ_HOST=
RABBITMQ_URL=
# Kafka Configuration
KAFKA_BROKER=
# JWT Secret Key
JWT_SECRET=
# Elasticsearch Configuration
ELASTIC_SEARCH_URL=
# PostgreSQL Configuration
POSTGRES_URL=
```
## **CLI Usage**
The `budget-manager` CLI provides a convenient way to interact with the application from the command line.
Follow these steps to use the CLI:
1. Install globally:
```bash
npm link
```
2. Use commands:
```bash
budget-manager seed
budget-manager notify "Hello!"
budget-manager add-task "Task description"
```
3. View available commands:
```bash
budget-manager --help
```
## **Swagger Documentation**
- Comprehensive API documentation is available at `/docs`.
- Includes all endpoints, schemas, and examples.
- Use Swagger UI to test and interact with the API.
- The Swagger UI looks like this:
## **GraphQL Integration**
- The Budget Management API supports GraphQL queries and mutations.
- Access the GraphQL endpoint at `http://localhost:3000/api/graphql`.
- Use the GraphiQL interface to interact with the API.
- The GraphiQL interface looks like this:
## **NGINX Configuration**
- The `nginx` directory contains an Nginx configuration for reverse proxy and load balancing.
- Use Nginx to route requests to multiple instances of the API.
- Configure SSL termination and caching for improved performance.
- The Nginx configuration looks like this:
```nginx
server {
listen 80;
server_name localhost;
location / {
proxy_pass http://localhost:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection 'upgrade';
proxy_set_header Host $host;
proxy_cache_bypass $http_upgrade;
}
}
```
- For more information, refer to the [Nginx documentation](https://nginx.org/en/docs/) and the [Nginx Directory](nginx/README.md).
## **gRPC Integration**
The Budget Management API includes support for **gRPC** to enable high-performance remote procedure calls.
### **Getting Started**
1. **Start the gRPC Server**:
Run the following command:
```bash
node grpcServer.js
```
2. **Use the gRPC Client**:
Execute the client to interact with the server:
```bash
node grpcClient.js
```
3. **Proto File**:
The `.proto` file for defining gRPC services and messages is located in the `protos` directory.
That's it! Your gRPC server and client should now be operational. 🚀
## **Dockerization**
The Budget Management API can be run in a Docker container for easy deployment and scaling.
You can build and run the app using Docker Compose:
```bash
docker-compose up --build
```
## **Kubernetes Deployment**
1. Create Kubernetes manifests for the services.
2. Deploy to a cluster:
```bash
kubectl apply -f kubernetes/
```
3. Access the application using the service URL.
## **Continuous Integration and Deployment with Jenkins**
The Budget Management API includes a Jenkins pipeline for continuous integration and deployment.
1. **Pipeline Configuration:** The `Jenkinsfile` defines the CI/CD pipeline stages, including code checkout, dependency installation, testing, building, and deployment. Add it to the root of the project.
2. **Job Setup:** Create a pipeline job in Jenkins, point it to the repository, and configure it to use the `Jenkinsfile`.
3. **Automated Testing:** The pipeline runs `npm test` to ensure all tests pass before proceeding to the build or deployment stages.
4. **Environment Variables:** Use Jenkins environment variables to securely manage secrets like API keys and credentials for services such as MongoDB, Redis, or Render.
5. **Deployment:** The pipeline supports deploying the application using Render or directly to a server using SSH and PM2.
6. **Webhooks:** Integrate GitHub/GitLab webhooks to trigger builds automatically on code changes.
7. **Notifications:** Add Slack or email notifications in the pipeline to inform team members about build and deployment statuses.
## **Testing**
The Budget Management API includes unit tests for all endpoints and services.
To run the tests, use the following command:
```bash
npm test
```
The test results will be displayed in the console.
## **Contributing**
Contributions are welcome! Please fork the repository, create a feature branch, and submit a pull request:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make changes and commit them (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Create a new pull request. We will review your changes and merge them if they look good.
## **Author**
- **Son Nguyen** - [hoangsonww](https://github.com/hoangsonww)
- **Website:** [https://sonnguyenhoang.com](https://sonnguyenhoang.com)
- **Email:** [[email protected]](mailto:[email protected])
- **LinkedIn:** [https://www.linkedin.com/in/hoangsonw](https://www.linkedin.com/in/hoangsonw)
- Feel free to reach out if you have any questions or feedback! 🚀
---
Thank you for using the **Budget Management API**. For questions, feedback, or support, please open an issue or [contact me directly](mailto:[email protected]).
Created with ❤️ by [Son Nguyen](https://sonnguyenhoang.com) in 2024. All rights reserved.
---
[⬆️ Back to Top](#budget-management-backend-api)