https://github.com/libercosoft/blockhouse-api
https://github.com/libercosoft/blockhouse-api
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/libercosoft/blockhouse-api
- Owner: LIBERCOSOFT
- License: mit
- Created: 2025-02-26T23:22:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-27T12:05:43.000Z (over 1 year ago)
- Last Synced: 2025-11-22T04:03:43.885Z (7 months ago)
- Language: Python
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [📝 License](#license)
**Blockhouse API** is a web service that allows users to fetch order details and update the status of an order in a trading system. It provides a RESTful API for seamless order management and transaction processing.
WebSocket Support for real-time order updates
## 🛠 Built With
#### Client
- None (API-only service)
#### Server
- [FastAPI](https://fastapi.tiangolo.com/)
- [Docker](https://www.docker.com/)
#### Database
- [PostgreSQL](https://www.postgresql.org/)
### 📖 API Documentation
- [Local API Docs (OpenAPI)](http://localhost:8000/docs)
- [Local Redoc API Docs](http://localhost:8000/redoc)
- **Fetch Order Details** - Retrieve details of a specific order by order ID.
- **Update Order Status** - Modify the status of an existing order.
- **Websocket Integration** - Real-time updates for order status changes.
> The project is not yet live. A demo link will be added soon.
- [Live Demo Link](#)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project, you need:
- Python 3.11+
- PostgreSQL
- Docker & Docker Compose
### Setup
Clone this repository:
```sh
git clone https://github.com/LIBERCOSOFT/blockhouse-api.git
cd blockhouse-api
```
### Install
Install this project with:
```sh
pip install -r requirements.txt
```
### Usage
To run the project, execute the following command:
- With Docker
```sh
docker-compose up
```
- Without Docker
```sh
uvicorn main:app --reload
```
### Deployment
You can deploy this project using:
```sh
docker-compose up --build -d
```
👤 **Kolapo Akinrinlola**
- GitHub: [LIBERCOSOFT](https://github.com/LIBERCOSOFT)
- Twitter: [@Gerfieldt](https://twitter.com/Gerfieldt)
- LinkedIn: [Kolapo Akinrinlola](https://linkedin.com/in/kolapo-akinrinlola)
- [ ] **Authentication & Authorization for secure access**
- [ ] **Order Analytics Dashboard for insights and trends**
This project is [MIT](./LICENSE) licensed.