market-data-service/docs

Documentation Index

Welcome to the Market Data Service documentation. This index helps you find the right guide for your needs.

📖 Documentation Guide

Getting Started

• Main README - Project overview, features, and quick start
• Local Development Setup - Complete guide for local development with MT5 EA
• Production Deployment - Production deployment with containerized SSL certificates

Configuration & Setup

• Configuration Guide - Environment variables and configuration options
• Docker Guide - Docker containerization details and usage

API & Integration

• API Contract - Complete API endpoint specifications
• MT5 Operation - MT5 Expert Advisor configuration and operation

Reference

• Archive - Historical documentation and reports

🚀 Quick Navigation

I want to...

Set up local development: → LOCAL_DEV_SETUP.md

Deploy to production: → DEPLOYMENT.md

Configure environment variables: → CONFIGURATION.md

Use Docker: → DOCKER.md

Understand the API: → API_CONTRACT.md

Configure MT5 EA: → MT5_OPERATION.md

📁 Documentation Structure

docs/
├── README.md              # This file - documentation index
├── LOCAL_DEV_SETUP.md     # Local development guide
├── DEPLOYMENT.md          # Production deployment guide
├── CONFIGURATION.md       # Configuration guide
├── API_CONTRACT.md        # API specifications
├── MT5_OPERATION.md      # MT5 EA guide
└── ARCHIVE/              # Historical documentation
    └── PRODUCTION_READINESS_REPORT.md

🔗 External Links

• Docker Documentation
• Let's Encrypt Documentation
• Nginx Documentation
• PostgreSQL Documentation