70 lines (50 loc) · 1.79 KB

📈 ROBINHOOK: REAL-TIME STOCK DATA

🚀 Overview

Fetches real-time market data from multiple providers
Processes data via a Kafka streaming pipeline
Computes moving averages and stores results in PostgreSQL
Exposes RESTful APIs for data access
Includes robust documentation, testing, and DevOps tooling

⚙️ Setup

Clone the repository

git clone https://github.com/yourusername/robinhook.git
cd robinhook

Environment variables
- Copy .env.example to .env and adjust as needed (DB, Redis, Kafka, provider keys).
Start services with Docker Compose
```
docker-compose up --build
```
Run tests
```
pip install -r requirements.txt
pytest
```

🛠️ Local Development

Use the provided docker-compose.yaml for all dependencies
Hot-reload enabled with uvicorn in development
Set PYTHONPATH to project root for local testing:
- Windows: set PYTHONPATH=%cd%
- Unix/Mac: export PYTHONPATH=$(pwd)
Run tests with pytest

🏗️ Architecture Decisions

FastAPI for async, type-safe APIs
PostgreSQL for transactional storage
Kafka for event streaming and decoupled processing
Redis for caching
Prometheus & Grafana for monitoring
Docker Compose for local orchestration
GitHub Actions for CI/CD

System Architecture

📚 API Documentation

See APIdoc.md for full API documentation and usage examples.

☁️ Cloud Deployment

For AWS deployment and cloud infrastructure configuration, see Terraform/Readme.md.