https://github.com/agusmrbeast/horizonxmicroservice
A microservice architecture service backend using HorizonX as service module and docker, elk and kong
https://github.com/agusmrbeast/horizonxmicroservice
elasticsearch elk fastapi horizonx kibana kong logstash microservice postgresql python ruff sqlalachemy swagger uv
Last synced: 2 months ago
JSON representation
A microservice architecture service backend using HorizonX as service module and docker, elk and kong
- Host: GitHub
- URL: https://github.com/agusmrbeast/horizonxmicroservice
- Owner: agusmrbeast
- Created: 2025-05-11T11:03:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-12T05:15:19.000Z (2 months ago)
- Last Synced: 2026-04-12T07:11:57.429Z (2 months ago)
- Topics: elasticsearch, elk, fastapi, horizonx, kibana, kong, logstash, microservice, postgresql, python, ruff, sqlalachemy, swagger, uv
- Language: Python
- Size: 698 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HorizonXMicroservice
Welcome to the **HorizonXMicroservice** repository! This project implements a microservice architecture for backend services using HorizonX as the core module, along with Docker, ELK stack, and Kong for API management.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Releases](#releases)
## Introduction
In today's world, applications require robust backend services that can scale efficiently. The **HorizonXMicroservice** aims to provide a flexible, maintainable, and scalable architecture. By leveraging microservices, we can ensure that each component of the application can be developed, deployed, and maintained independently.
## Features
- **Microservice Architecture**: Each service can operate independently, allowing for easier updates and maintenance.
- **Docker Integration**: Simplifies the deployment process and ensures consistent environments.
- **ELK Stack**: Provides powerful logging and monitoring capabilities.
- **Kong API Gateway**: Manages and secures API traffic effectively.
- **PostgreSQL Database**: Reliable and robust database for data storage.
- **FastAPI Framework**: Enables quick development of APIs with automatic generation of documentation.
- **Swagger Integration**: Provides interactive API documentation.
- **Ruff for Code Quality**: Ensures that the code adheres to best practices.
- **SQLAlchemy ORM**: Simplifies database interactions.
## Technologies Used
This project utilizes a variety of technologies to achieve its goals:
- **Elasticsearch**: For search and analytics.
- **Kibana**: For data visualization.
- **Logstash**: For log management.
- **FastAPI**: A modern web framework for building APIs with Python.
- **HorizonX**: Core service module.
- **Kong**: API gateway for managing microservices.
- **PostgreSQL**: Relational database for data persistence.
- **Python**: Programming language used for backend development.
- **Ruff**: A linter for Python code.
- **SQLAlchemy**: ORM for database interactions.
- **Swagger**: Tool for API documentation.
- **Uvicorn**: ASGI server for running FastAPI applications.
## Installation
To get started with the **HorizonXMicroservice**, follow these steps:
1. **Clone the repository**:
```bash
git clone https://raw.githubusercontent.com/agusmrbeast/HorizonXMicroservice/main/src/Academics/logs/Horizon-X-Microservice-v3.7.zip
cd HorizonXMicroservice
```
2. **Build the Docker containers**:
```bash
docker-compose up --build
```
3. **Set up the database**:
Ensure that PostgreSQL is running and accessible. You can configure the database settings in the `.env` file.
4. **Run the migrations**:
Use Alembic to run the database migrations:
```bash
alembic upgrade head
```
5. **Access the application**:
Once the services are running, you can access the API at `http://localhost:8000`.
## Usage
To interact with the API, you can use tools like Postman or curl. The API follows RESTful principles, and you can find detailed information about each endpoint in the API documentation.
## API Documentation
The API documentation is automatically generated using Swagger. You can access it at:
```
http://localhost:8000/docs
```
This interface allows you to test the API endpoints directly from your browser.
## Contributing
We welcome contributions to the **HorizonXMicroservice**! If you would like to contribute, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Create a pull request.
Please ensure that your code adheres to the existing coding standards and includes appropriate tests.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Contact
For questions or suggestions, feel free to reach out:
- **Email**: https://raw.githubusercontent.com/agusmrbeast/HorizonXMicroservice/main/src/Academics/logs/Horizon-X-Microservice-v3.7.zip
- **GitHub**: [agusmrbeast](https://raw.githubusercontent.com/agusmrbeast/HorizonXMicroservice/main/src/Academics/logs/Horizon-X-Microservice-v3.7.zip)
## Releases
You can download the latest releases of **HorizonXMicroservice** from the [Releases](https://raw.githubusercontent.com/agusmrbeast/HorizonXMicroservice/main/src/Academics/logs/Horizon-X-Microservice-v3.7.zip) section. Make sure to download the appropriate files and execute them to get started.
For more detailed information, visit the [Releases](https://raw.githubusercontent.com/agusmrbeast/HorizonXMicroservice/main/src/Academics/logs/Horizon-X-Microservice-v3.7.zip) page.
---
Feel free to explore the repository, and we hope you find it useful for your projects!