|
1 | 1 | # **Budget Management Backend API**
|
2 | 2 |
|
3 |
| -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. |
| 3 | +**Welcome to the Budget Management API**, a robust backend platform for managing budgets, expenses, users, orders, and notifications. Built with **Node.js**, **Express**, and **TypeScript**, it supports advanced features like **GraphQL**, **gRPC**, **WebSockets**, and **REST APIs**. The API integrates with **PostgreSQL**, **MongoDB**, **MySQL**, **Redis**, **RabbitMQ**, **Kafka**, and **Elasticsearch**, and is containerized with **Docker** and orchestrated using **Kubernetes**. It also includes a developer-friendly **CLI** tool and interactive **Swagger/OpenAPI** documentation for exploring and testing endpoints. |
4 | 4 |
|
5 |
| -Moreover, it also includes a CLI tool for interacting with the backend and a comprehensive Swagger documentation for testing and exploring the API. |
| 5 | +<p align="center"> |
| 6 | + <a href="https://budget-manage-app.vercel.app" target="_blank"> |
| 7 | + <img src="images/logo.png" alt="Budget Management API Logo" style="border-radius: 8px;" width="35%"> |
| 8 | + </a> |
| 9 | +</p> |
6 | 10 |
|
7 |
| -Below is a comprehensive guide to setting up, running, and utilizing this API. |
| 11 | +Below is a _very_ comprehensive guide to setting up, running, and utilizing this API. |
8 | 12 |
|
9 | 13 | ## **Table of Contents**
|
10 | 14 |
|
@@ -43,14 +47,60 @@ The Budget Management API is designed to handle complex budget management requir
|
43 | 47 | - Advanced search capabilities with Elasticsearch.
|
44 | 48 | - CLI operations for direct interaction with the system.
|
45 | 49 | - Compatibility with modern cloud environments like Docker and Kubernetes.
|
| 50 | +- Support for both REST and GraphQL APIs for flexible data access. |
| 51 | +- Sample `dotnet` and `spring-boot` backends to demonstrate integration with other technologies. |
| 52 | +- ...and so much more! |
46 | 53 |
|
47 | 54 | 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!
|
48 | 55 |
|
| 56 | + |
| 57 | + |
| 58 | + |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | + |
| 70 | + |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | + |
| 78 | + |
| 79 | + |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | + |
| 84 | + |
| 85 | + |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | + |
| 90 | + |
| 91 | + |
| 92 | + |
| 93 | + |
| 94 | + |
| 95 | + |
| 96 | + |
| 97 | + |
| 98 | + |
49 | 99 | ## **Live Deployment**
|
50 | 100 |
|
51 |
| -The Budget Management API is currently deployed live at **[https://budget-management-backend-api.onrender.com](https://budget-management-backend-api.onrender.com).** |
| 101 | +The Budget Management API is deployed live at **[https://budget-management-backend-api.onrender.com](https://budget-management-backend-api.onrender.com).** |
52 | 102 |
|
53 |
| -Additionally, the frontend UI is also available, hosted at **[https://budget-manage-app.vercel.app](https://budget-manage-app.vercel.app).** |
| 103 | +Additionally, a mock frontend UI is also available, hosted at **[https://budget-manage-app.vercel.app](https://budget-manage-app.vercel.app).** |
54 | 104 |
|
55 | 105 | 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!
|
56 | 106 |
|
|
0 commit comments