Skip to content

Quick Start Guide

Get Started in Minutes

This guide will walk you through setting up Quantbot and accessing its core features.

Prerequisites

Before you begin, ensure you have:

  • Docker & Docker Compose (recommended)
  • Node.js 18+ (for local development)
  • Python 3.12+ (for local development)

Installation

# Clone the repository
git clone https://github.com/bakr-UCB/Quantbot.git
cd Quantbot

# Start all services with hot reload
docker compose up --watch

Option 2: Local Development

cd Quantbot-BE
make create_environment
make requirements
uvicorn app.main:app --reload --host 0.0.0.0 --port 8000

cd Quantbot-FE
npm install
npm run dev

Access the Application

Once running, access Quantbot at:

Core Features Overview

1. AI Chat Assistant

Ask questions about markets, stocks, and investment strategies:

"What's the current sentiment on AAPL?"
"Should I diversify my tech portfolio?"
"Explain the latest Fed announcement impact"

2. Portfolio Management

  • Track your investments in real-time
  • View performance metrics and analytics
  • Get AI-powered rebalancing recommendations

3. Market Data

  • Real-time stock quotes and market data
  • Technical indicators and chart analysis
  • News sentiment analysis

4. Mobile Experience

  • Responsive design works on all devices
  • Touch-friendly interface
  • Hamburger navigation for mobile

Design System

Color Scheme

Quantbot uses a professional blue-to-purple gradient theme:

Element Color Hex Code
Primary Gradient Blue → Purple #B234F1 → #8E3CF7
Background Light Gray #F9F9FC
Text Dark #1F1F1F
Accent Pink #FF5BE1
Success Green #2ECC71

Logo Sizing

  • Desktop Navigation: 80px height
  • Mobile Menu: 60px height
  • Sidebar Expanded: 80px height
  • Sidebar Minimized: 40px height

Responsive Breakpoints

sm: 640px   /* Small devices */
md: 768px   /* Medium devices */
lg: 1024px  /* Large devices */
xl: 1280px  /* Extra large devices */

API Usage

Authentication

# Get access token
curl -X POST "http://localhost:8000/api/v1/auth/login" \
  -H "Content-Type: application/json" \
  -d '{"username": "your_username", "password": "your_password"}'

Portfolio Data

# Get portfolio summary
curl -X GET "http://localhost:8000/api/v1/portfolio" \
  -H "Authorization: Bearer YOUR_TOKEN"

Market Data

# Get stock quote
curl -X GET "http://localhost:8000/api/v1/market/stock/AAPL" \
  -H "Authorization: Bearer YOUR_TOKEN"

Configuration

Environment Variables

Create a .env file in the backend directory:

# Database
DATABASE_URL=postgresql://user:password@localhost/quantbot

# API Keys (optional - for enhanced features)
NEWS_API_KEY=your_news_api_key
GOOGLE_API_KEY=your_google_api_key
OPENAI_API_KEY=your_openai_api_key
FINNHUB_API_KEY=your_finnhub_api_key
FMP_API_KEY=your_fmp_api_key

# Security
SECRET_KEY=your_secret_key

API Keys

API keys are optional but recommended for full functionality. Never commit real API keys to version control.

Next Steps

  1. Explore Features - Check out the Feature Overview
  2. API Reference - Browse the API Documentation
  3. Architecture - Learn about the System Architecture
  4. Contributing - See how to contribute to the project

Troubleshooting

Common Issues

Port Already in Use 

# Check what's using the port
lsof -i :5173
lsof -i :8000

# Kill the process or use different ports
docker compose down

Database Connection Issues 

# Reset the database
docker compose down -v
docker compose up -d

Build Failures 

# Clean rebuild
docker compose build --no-cache
docker compose up -d

Support

You're Ready!

Quantbot is now running and ready to help with your financial decisions. Start by asking the AI assistant a question about the markets!