Bill/AI-Trader
1
0
Fork 0
mirror of https://github.com/Xe138/AI-Trader.git synced 2026-04-14 14:07:24 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: rebrand QUICK_START.md to AI-Trader-Server

Browse Source 
Updates Quick Start Guide with rebranded project name:
- Project name: AI-Trader → AI-Trader-Server
- Repository URL: github.com/Xe138/AI-Trader → github.com/Xe138/AI-Trader-Server
- Container name: ai-trader → ai-trader-server
- GitHub issues link updated to new repository

Part of Phase 1 core documentation rebrand.
This commit is contained in:
Bill Ballou
2025-11-01 11:27:10 -04:00
parent 6fa2bec043
commit b706a48ee1
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
QUICK_START.md
View File

@@ -1,6 +1,6 @@
# Quick Start Guide # Quick Start Guide
Get AI-Trader running in under 5 minutes using Docker. Get AI-Trader-Server running in under 5 minutes using Docker.
--- ---
@@ -21,8 +21,8 @@ Get AI-Trader running in under 5 minutes using Docker.
## Step 1: Clone Repository ## Step 1: Clone Repository
```bash ```bash
git clone https://github.com/Xe138/AI-Trader.git git clone https://github.com/Xe138/AI-Trader-Server.git
cd AI-Trader cd AI-Trader-Server
``` ```
--- ---
@@ -62,7 +62,7 @@ docker-compose up -d
This will: This will:
- Build the Docker image (~5-10 minutes first time) - Build the Docker image (~5-10 minutes first time)
- Start the AI-Trader API service - Start the AI-Trader-Server API service
- Start internal MCP services (math, search, trade, price) - Start internal MCP services (math, search, trade, price)
- Initialize the SQLite database - Initialize the SQLite database
@@ -70,7 +70,7 @@ This will:
```bash ```bash
# View logs # View logs
docker logs -f ai-trader docker logs -f ai-trader-server
# Wait for this message: # Wait for this message:
# "Application startup complete" # "Application startup complete"
@@ -261,7 +261,7 @@ curl "http://localhost:8080/results?date=2025-01-16&model=gpt-4"
```bash ```bash
# Check logs # Check logs
docker logs ai-trader docker logs ai-trader-server
# Common issues: # Common issues:
# - Missing API keys in .env # - Missing API keys in .env
@@ -288,13 +288,13 @@ docker-compose up -d
```bash ```bash
# Check if container is running # Check if container is running
docker ps | grep ai-trader docker ps | grep ai-trader-server
# Restart service # Restart service
docker-compose restart docker-compose restart
# Check for errors in logs # Check for errors in logs
docker logs ai-trader | grep -i error docker logs ai-trader-server | grep -i error
``` ```
### Job stays "pending" ### Job stays "pending"
@@ -303,7 +303,7 @@ The simulation might still be downloading price data on first run.
```bash ```bash
# Watch logs in real-time # Watch logs in real-time
docker logs -f ai-trader docker logs -f ai-trader-server
# Look for messages like: # Look for messages like:
# "Downloading missing price data..." # "Downloading missing price data..."
@@ -321,7 +321,7 @@ This means price data is missing for the requested date range.
**Solution 2:** Manually download price data: **Solution 2:** Manually download price data:
```bash ```bash
docker exec -it ai-trader bash docker exec -it ai-trader-server bash
cd data cd data
python get_daily_price.py python get_daily_price.py
python merge_jsonl.py python merge_jsonl.py
@@ -334,7 +334,7 @@ exit
```bash ```bash
# View logs # View logs
docker logs -f ai-trader docker logs -f ai-trader-server
# Stop service # Stop service
docker-compose down docker-compose down
@@ -349,10 +349,10 @@ docker-compose restart
curl http://localhost:8080/health curl http://localhost:8080/health
# Access container shell # Access container shell
docker exec -it ai-trader bash docker exec -it ai-trader-server bash
# View database # View database
docker exec -it ai-trader sqlite3 /app/data/jobs.db docker exec -it ai-trader-server sqlite3 /app/data/jobs.db
``` ```
--- ---
@@ -369,5 +369,5 @@ docker exec -it ai-trader sqlite3 /app/data/jobs.db
## Need Help? ## Need Help?
- Check [docs/user-guide/troubleshooting.md](docs/user-guide/troubleshooting.md) - Check [docs/user-guide/troubleshooting.md](docs/user-guide/troubleshooting.md)
- Review logs: `docker logs ai-trader` - Review logs: `docker logs ai-trader-server`
- Open an issue: [GitHub Issues](https://github.com/Xe138/AI-Trader/issues) - Open an issue: [GitHub Issues](https://github.com/Xe138/AI-Trader-Server/issues)