Skip to content

QUICK_START.md

Latest commit

 

History

History
235 lines (180 loc) · 7.43 KB

QUICK_START.md

File metadata and controls

235 lines (180 loc) · 7.43 KB
Raw

PowerTrader AI+ Development Quick Start

🎯 Goal: Resume safe, systematic development from prototype to production-grade enterprise trading platform.

📍 Current Status Summary

  • Current State: Phase 1 (Security Foundations) substantially complete — see GitHub issues for active backlog
  • Active Backlog: Feature issues #100–#106 raised (Personas, Multi-LLM, MCP, Macro Data, Sentiment, Risk Metrics, Docker)
  • Development Plan: 4-phase approach over 16 weeks
  • Immediate Need: Phase 2 functional completeness

🚨 BEFORE YOU START - SAFETY FIRST

⚠️ Critical Actions Required

  1. Verify paper trading mode is active before making any code changes to trading logic
  2. Backup current system completely
  3. Create development environment separate from any live systems
# 1. Backup current system
# Windows (PowerShell):
Copy-Item -Recurse PowerTraderAI "PowerTraderAI_BACKUP_$(Get-Date -Format yyyyMMdd)"
# Linux/Mac:
# cp -r PowerTraderAI PowerTraderAI_BACKUP_$(date +%Y%m%d)

# 2. Verify no live trading is occurring
# Windows (PowerShell):
Select-String -Path app\*.py -Pattern 'paper_trading.*False'
# Linux/Mac:
# grep -r "paper_trading.*False" app/ && echo "⚠️ LIVE TRADING ENABLED - DISABLE NOW"

# 3. Create development branch
git checkout -b development-phase1

🚀 Quick Resume Development (5 Steps)

Step 1: Environment Setup (5 minutes)

# Clone or navigate to repository
cd PowerTraderAI

# Activate virtual environment
.venv\Scripts\activate  # Windows
# source .venv/bin/activate  # Linux/Mac

# Verify dependencies
pip install -r requirements.txt

# Verify system status
python app/test_dependencies.py

Step 2: GitHub Project Setup (10 minutes)

# Install project management dependencies
pip install requests

# Create GitHub Personal Access Token (if needed)
# Go to: GitHub Settings > Developer settings > Personal access tokens
# Permissions needed: repo (full repository access)

# Set up project structure (preview first)
python scripts/create_github_issues.py --token YOUR_TOKEN --owner YOUR_USERNAME --dry-run

# Create the actual project
python scripts/create_github_issues.py --token YOUR_TOKEN --owner YOUR_USERNAME

Step 3: Pick up the next Sprint task

# Review the active sprint on the GitHub Project board:
# https://github.com/users/sjackson0109/projects/11/views/1
#
# Filter by Status=Ready to find unassigned tasks.
# Create a branch for the issue you pick up:
git checkout -b feature/<short-description>

Step 4: Follow Development Workflow

  1. Pick issue from GitHub project Phase 1 board
  2. Create feature branch from development-phase1
  3. Implement with tests following security guidelines
  4. Submit pull request using PR template
  5. Get security review for security-related changes

Step 5: Track Progress

  • Daily: Check GitHub project board for next tasks
  • Weekly: Review Phase 1 milestone progress
  • Monthly: Assess readiness for Phase 2 transition

📋 Phase 1 Priority Order (First 4 Weeks)

Week 1: Critical Security Fixes

# Immediate tasks (choose one to start):

# Task 1: Secure credential management (HIGHEST PRIORITY)
git checkout -b feature/encrypt-credentials
# Files to edit: app/pt_credentials.py, app/pt_trader.py

# Task 2: Replace bare except blocks
git checkout -b feature/proper-error-handling
# Files to scan: app/pt_trader.py (lines 2495+), app/pt_hub.py

# Task 3: Database security
git checkout -b feature/database-security
# Files to edit: app/migrations.py, app/order_management_db.py

Week 2: Error Handling & Logging

  • Complete centralized error management
  • Implement production logging system
  • Add security event tracking

Week 3: Database & Validation

  • Implement transaction management
  • Add comprehensive input validation
  • Create backup/restore procedures

Week 4: Testing & Security Audit

  • Expand test coverage for security fixes
  • Run security scans and audits
  • Prepare for Phase 2 transition

🔧 Development Guidelines

Code Changes Must Include:

  1. Specific error handling (no bare except: blocks)
  2. Security review for anything touching credentials/trading
  3. Tests for all new functionality
  4. Documentation updates for significant changes

Security Requirements:

  • No plaintext credentials anywhere in code
  • Input validation for all external data
  • Audit logging for security events
  • Encrypted storage for sensitive data

Quality Gates:

  • All tests passing
  • Security scan clean
  • Code review approved
  • Documentation updated

📊 Track Your Progress

Daily Checklist

  • Review GitHub project board
  • Work on current Phase 1 task
  • Update issue with progress
  • Run tests for changes

Weekly Review

  • Complete previous week's tasks
  • Plan next week's priorities
  • Update milestone progress
  • Address any blockers

Phase Completion Criteria

Phase 1 Complete When:

  • No plaintext credentials in codebase
  • Comprehensive error handling implemented
  • Database security measures in place
  • Production-grade logging operational
  • Security audit passed

🔥 Emergency Procedures

If System Breaks

  1. Stop all trading immediately
  2. Revert to backup if necessary
  3. Check Git history for recent changes
  4. Create hotfix branch for urgent fixes

If Security Issue Discovered

  1. Create security issue immediately using GitHub template
  2. Disable affected functionality
  3. Notify team through secure channels
  4. Implement fix in isolation

If Live Trading Occurs Accidentally

  1. Emergency stop all trading
  2. Review all transactions for accuracy
  3. Document incident thoroughly
  4. Strengthen safeguards to prevent recurrence

🎯 Success Metrics

Phase 1 Success Indicators:

  • Zero security vulnerabilities in static analysis
  • 95%+ test coverage for security-critical code
  • Clean error handling throughout codebase
  • Audit trail for all sensitive operations

Development Velocity Targets:

  • Week 1: 3-5 security issues resolved
  • Week 2: Error handling system complete
  • Week 3: Database security implemented
  • Week 4: Security audit passed

❓ Need Help?

Quick References:

Common Questions:

Q: Which task should I start with? A: Start with secure credential management - it's the highest security risk.

Q: Can I use live trading while developing? A: NO - Only paper trading until Phase 2 complete and security audit passed.

Q: How do I know if a change is safe? A: All security-related changes need review. When in doubt, create an issue and ask.

Q: What if I break something? A: Test changes thoroughly, use feature branches, and maintain good commit hygiene for easy rollback.

🚨 Remember: Safety First

This is financial trading software. Security and stability are paramount. When in doubt, ask for help rather than risk system integrity.

Last Updated: March 16, 2026 Project Owner: Development Team Emergency Contact: Security Team Lead

🎉 You're ready to start! Begin with Phase 1, Week 1, Task 1: Secure Credential Management