TCPDashboard/README.md

# Crypto Trading Bot Platform

A simplified crypto trading bot platform for strategy testing and development using real OKX market data and virtual trading simulation.

## Overview

This platform enables rapid strategy development with a monolithic architecture that supports multiple concurrent trading bots, real-time monitoring, and performance tracking.

## Key Features

- **Multi-Bot Management**: Run multiple trading bots simultaneously with different strategies.
- **Real-time Monitoring**: Live OHLCV charts with bot trading signals overlay.
- **Modular Chart System**: Advanced technical analysis with 26+ indicators and strategy presets.
- **Virtual Trading**: Simulation-first approach with realistic fee modeling.
- **JSON Configuration**: Easy strategy parameter testing without code changes.
- **Backtesting Engine**: Test strategies on historical market data (planned).
- **Crash Recovery**: Automatic bot restart and state restoration.

## Tech Stack

- **Framework**: Python 3.10+ with Dash
- **Database**: PostgreSQL
- **Real-time Messaging**: Redis
- **Package Management**: UV
- **Containerization**: Docker

## Quick Start

For detailed instructions on setting up and running the project, please refer to the main documentation.

**➡️ [Go to the Full Documentation](./docs/README.md)**

```bash
# Quick setup for development
git clone <repository>
cd TCPDashboard
uv sync
cp env.template .env
docker-compose up -d
uv run python main.py
```

## Documentation

All project documentation is located in the `docs/` directory. The best place to start is the main documentation index.

- **[Main Documentation](./docs/README.md)** - The central hub for all project documentation, including setup guides, architecture, and module details.
- **[Setup Guide](./docs/guides/setup.md)** - Complete setup instructions for new machines.
- **[Project Context](./CONTEXT.md)** - The single source of truth for the project's current state.

## Contributing

We welcome contributions! Please review the **[Contributing Guidelines](./docs/CONTRIBUTING.md)** and the **[Project Context](./CONTEXT.md)** before getting started.
PRD 2025-05-30 16:43:09 +08:00			`# Crypto Trading Bot Platform`
init 2025-05-29 23:04:08 +08:00
documentation update 2025-06-06 20:33:29 +08:00			`A simplified crypto trading bot platform for strategy testing and development using real OKX market data and virtual trading simulation.`
init 2025-05-29 23:04:08 +08:00
PRD 2025-05-30 16:43:09 +08:00			`## Overview`
init 2025-05-29 23:04:08 +08:00
documentation update 2025-06-06 20:33:29 +08:00			`This platform enables rapid strategy development with a monolithic architecture that supports multiple concurrent trading bots, real-time monitoring, and performance tracking.`
PRD 2025-05-30 16:43:09 +08:00
			`## Key Features`

documentation update 2025-06-06 20:33:29 +08:00			`- Multi-Bot Management: Run multiple trading bots simultaneously with different strategies.`
			`- Real-time Monitoring: Live OHLCV charts with bot trading signals overlay.`
			`- Modular Chart System: Advanced technical analysis with 26+ indicators and strategy presets.`
			`- Virtual Trading: Simulation-first approach with realistic fee modeling.`
			`- JSON Configuration: Easy strategy parameter testing without code changes.`
			`- Backtesting Engine: Test strategies on historical market data (planned).`
			`- Crash Recovery: Automatic bot restart and state restoration.`
docs 2025-06-04 17:05:39 +08:00
init 2025-05-29 23:04:08 +08:00			`## Tech Stack`

documentation update 2025-06-06 20:33:29 +08:00			`- Framework: Python 3.10+ with Dash`
			`- Database: PostgreSQL`
			`- Real-time Messaging: Redis`
init 2025-05-29 23:04:08 +08:00			`- Package Management: UV`
documentation update 2025-06-06 20:33:29 +08:00			`- Containerization: Docker`
init 2025-05-29 23:04:08 +08:00
			`## Quick Start`

documentation update 2025-06-06 20:33:29 +08:00			`For detailed instructions on setting up and running the project, please refer to the main documentation.`
init setup 2025-05-30 17:27:32 +08:00
docs 2025-06-07 14:19:50 +08:00			`➡️ [Go to the Full Documentation](./docs/README.md)`
init setup 2025-05-30 17:27:32 +08:00
PRD 2025-05-30 16:43:09 +08:00			```bash
documentation update 2025-06-06 20:33:29 +08:00			`# Quick setup for development`
			`git clone <repository>`
			`cd TCPDashboard`
			`uv sync`
			`cp env.template .env`
			`docker-compose up -d`
			`uv run python main.py`
init 2025-05-29 23:04:08 +08:00			```

			`## Documentation`

documentation update 2025-06-06 20:33:29 +08:00			All project documentation is located in the `docs/` directory. The best place to start is the main documentation index.
init 2025-05-29 23:04:08 +08:00
docs 2025-06-07 14:21:13 +08:00			`- [Main Documentation](./docs/README.md) - The central hub for all project documentation, including setup guides, architecture, and module details.`
			`- [Setup Guide](./docs/guides/setup.md) - Complete setup instructions for new machines.`
			`- [Project Context](./CONTEXT.md) - The single source of truth for the project's current state.`
init 2025-05-29 23:04:08 +08:00
			`## Contributing`

docs 2025-06-07 14:21:13 +08:00			`We welcome contributions! Please review the [Contributing Guidelines](./docs/CONTRIBUTING.md) and the [Project Context](./CONTEXT.md) before getting started.`