Quick Start Guide

On this page

This guide will help you get DeepTrade up and running quickly. Follow these steps to start analyzing investments with AI-powered insights.

Prerequisites

Before you begin, ensure you have:

  • Node.js 18.0.0 or higher
  • pnpm 8.0.0 or higher
  • An OpenAI API key
  • A financial data API key (e.g., Alpha Vantage, Yahoo Finance, etc.)

Step 1: Clone the Repository

git clone https://github.com/yourusername/deeptrade.git
cd deeptrade

Step 2: Set Up Environment Variables

Create a .env.local file in the root directory with the following variables:

# OPENAI_API_KEY needs to be base64 encoded
# You can generate it with: echo -n "your-openai-key" | base64
OPENAI_API_KEY=your-base64-encoded-openai-key
FINANCIAL_API_KEY=your-financial-data-api-key

Step 3: Install Dependencies

pnpm install

Step 4: Start the Development Server

pnpm dev

This will start the development server at http://localhost:3000.

Step 5: Access the Trading Analysis Interface

Navigate to http://localhost:3000/trading in your browser to access the DeepTrade analysis interface.

Step 6: Analyze Your First Stock

  1. In the stock selector, enter a stock symbol (e.g., AAPL, MSFT, GOOGL)
  2. Click "Analyze" to start the analysis process
  3. Watch as the different agents analyze the stock in real-time
  4. Review the comprehensive analysis and recommendations

Quick Start Demo

Next Steps

Now that you have DeepTrade up and running, you can:

  • Explore different stocks and compare analysis results
  • Adjust agent weightings to match your investment philosophy
  • Integrate DeepTrade with your existing investment workflow
  • Explore the API for programmatic access to analysis results

For more detailed information, check out the User Guide and API Reference.

Troubleshooting

If you encounter any issues during setup:

  • Ensure your API keys are correctly formatted and have sufficient permissions
  • Check that you're using compatible versions of Node.js and pnpm
  • Review the Troubleshooting Guide for solutions to common problems

For additional help, join our community forum or submit an issue on GitHub.