cursor-instructions/QUICK_START_FOR_AI.md

# ⚡ QUICK START - For AI Developer

## 🎯 WHAT YOU NEED TO DO

**UPDATE an existing HuggingFace Space** to add 30+ comprehensive API endpoints for cryptocurrency data.

**⚠️ THIS IS AN UPDATE, NOT A NEW PROJECT!**

---

## 📖 READING ORDER (MANDATORY)

Read files in this **EXACT ORDER**:

### 1️⃣ `HF_DEPLOYMENT_SUMMARY.md` (5 min)
- Quick overview
- What we're building
- Why we need it

### 2️⃣ `SEND_TO_HF_TEAM.md` (10 min)  
- Official request letter
- Priorities and scope
- Success criteria

### 3️⃣ `DATA_ARCHITECTURE_ANALYSIS_REPORT.md` (30 min)
- Current architecture
- Problems we're solving
- Proposed solution

### 4️⃣ `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` (2-3 hours) ⭐ **MAIN REFERENCE**
- **Complete API specifications**
- All 30+ endpoint details
- Request/Response formats
- Python/FastAPI code
- Data source integration
- Caching, AI, WebSocket
- Deployment config
- Testing procedures

### 5️⃣ `ENGINEERING_GUIDE.md` (optional, 1 hour)
- Coding standards
- Best practices

---

## 🚀 IMPLEMENTATION ORDER

### Phase 1: Setup
- Access existing HF Space
- Install Python 3.9+ and Redis
- Install dependencies

### Phase 2: Core API
- Set up FastAPI
- Add CORS, Redis
- Create health check

### Phase 3-9: Implement Endpoints
- Market data (4 endpoints)
- News & sentiment (3 endpoints)
- Trading (3 endpoints)
- AI/ML (3 endpoints)
- Blockchain (2 endpoints)
- Statistics (3 endpoints)
- Historical (1 endpoint)

### Phase 10: WebSocket
- Real-time ticker
- Real-time trades

### Phase 11-12: Performance
- Caching
- Rate limiting
- Error handling

### Phase 13: Testing
- Test all endpoints
- Load testing

### Phase 14-15: Deploy
- Docker build
- Push to HF Space
- Production testing

---

## ⚠️ CRITICAL REMINDERS

### THIS IS AN UPDATE
```
✅ Update existing HuggingFace Space
✅ Add new endpoints
✅ Enhance existing features
❌ Don't create new space
❌ Don't break existing functionality
```

### PRIORITY
```
1. MUST HAVE:
   - GET /api/market
   - GET /api/ohlcv
   - GET /api/news/latest
   - GET /api/sentiment/global
   - GET /api/ai/signals

2. SHOULD HAVE:
   - All other REST endpoints
   - WebSocket /ws/ticker

3. NICE TO HAVE:
   - Advanced features
```

### QUALITY
```
✅ All endpoints return valid JSON
✅ Standard error format
✅ Caching on all endpoints
✅ Async/await throughout
✅ Fallback mechanisms
✅ Rate limiting
```

---

## 📚 QUICK REFERENCE

Need to find something? Check:

| What | Where |
|------|-------|
| Endpoint specs | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` → "API SPECIFICATIONS" |
| Code examples | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` → "TECHNICAL REQUIREMENTS" |
| Data sources | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` → "Data Sources Integration" |
| Caching | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` → "Caching Strategy" |
| AI models | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` → "AI/ML Models" |
| WebSocket | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` → "WebSocket Implementation" |
| Deployment | `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` → "DEPLOYMENT CONFIGURATION" |

---

## ✅ SUCCESS CRITERIA

Done when:
- ✅ All 30+ endpoints work
- ✅ WebSocket stable
- ✅ Caching improves performance
- ✅ AI models generate predictions
- ✅ `/docs` endpoint shows API docs
- ✅ Health check works
- ✅ No errors for 24 hours
- ✅ Response times meet requirements

---

## 🎯 YOUR FIRST 3 ACTIONS

1. Read `HF_DEPLOYMENT_SUMMARY.md`
2. Read `SEND_TO_HF_TEAM.md`
3. Read `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md` (your main reference)

**Then start Phase 1 implementation.**

---

## ⏱️ TIME ESTIMATE

- Reading: 3-4 hours
- Implementation: 3-5 days
- Testing: 1-2 days
- Deployment: 1 day
- **Total: 5-8 days**

---

## 🚨 REMEMBER

**THIS IS AN UPDATE REQUEST!** 🔄

Not creating new space ❌  
**UPDATING existing space** ✅

---

## 🚀 START NOW

**Begin with:** `HF_DEPLOYMENT_SUMMARY.md`

**Main reference:** `HUGGINGFACE_SPACE_DEPLOYMENT_REQUEST.md`

**Good luck!** 🎯