Skip to content

Support

🤝 Get Help & Support

Find answers, report issues, and get assistance with Quantbot through our comprehensive support resources and community channels.

Quick Help

🚀 Getting Started

🐛 Common Issues

Docker Issues

# If containers won't start
docker compose down
docker compose up --build

# Check container logs
docker compose logs -f backend
docker compose logs -f frontend

API Connection Issues

  • Verify backend is running on port 8000: curl http://localhost:8000/health
  • Check if your API keys are configured correctly
  • Ensure database containers are running: docker compose ps

Frontend Not Loading

  • Check if frontend is running on port 5173
  • Clear browser cache and cookies
  • Verify all environment variables are set

🔧 Configuration Help

Environment Variables

Check the .env file in both Quantbot-BE/ and Quantbot-FE/ directories:

# Backend - Critical variables
DATABASE_URL=postgresql+asyncpg://...
JWT_SECRET_KEY=your-secret-key
GOOGLE_API_KEY=your-google-api-key

# Frontend - API endpoint
VITE_API_URL=http://localhost:8000

API Keys Setup

  1. Google API Key - Required for AI chat functionality
  2. News API Key - Optional, enhances news features
  3. Finnhub API Key - Optional, adds social sentiment

See API Keys Documentation for detailed setup.

Community Support

📚 Documentation

🐞 Bug Reports

Found a bug? Please report it on GitHub:

  1. Check existing issues - Your issue might already be reported
  2. Use issue templates - Provides necessary information
  3. Include details:
  4. Operating system and version
  5. Browser (for frontend issues)
  6. Steps to reproduce
  7. Expected vs actual behavior
  8. Screenshots (if applicable)

Report a Bug on GitHub

💡 Feature Requests

Have an idea for improvement?

  1. Search existing features - It might already be planned
  2. Describe the use case - Why would this be valuable?
  3. Provide examples - How should it work?

Request a Feature on GitHub

Developer Support

🔨 Development Help

Setting Up Development Environment

# Clone and setup
git clone https://github.com/bakr-UCB/Quantbot.git
cd Quantbot

# Start databases
docker compose up postgres neo4j -d

# Backend development
cd Quantbot-BE
make create_environment
make requirements
uvicorn app.main:app --reload

# Frontend development
cd Quantbot-FE
npm install
npm run dev

Testing

# Run all tests
uv run pytest --cov=app --cov-report=term-missing tests/

# Run specific test types
uv run pytest tests/unit/ -v
uv run pytest tests/integration/ -v
uv run pytest evals/eval_tests/ -v

📖 Contributing

Want to contribute? Great! Check out:

Direct Contact

📧 For Academic/Research Inquiries

This is an academic graduation project. For research collaboration or academic inquiries:

  • GitHub Discussions - Best for technical questions
  • Issues - For bugs and feature requests
  • University Project - UC Berkeley Computer Science

🚨 Security Issues

Found a security vulnerability? Please report it responsibly:

  1. Do NOT create a public issue
  2. Email the maintainers with details
  3. Include steps to reproduce the vulnerability
  4. Allow time for a fix before public disclosure

FAQ

❓ Frequently Asked Questions

Q: Is Quantbot free to use?
A: Yes, Quantbot is open-source and free for personal and educational use.

Q: Do I need API keys to use Quantbot?
A: A Google API key is required for AI chat functionality. Other API keys enhance features but are optional.

Q: Can I use Quantbot for production trading?
A: Quantbot is an educational tool. Always verify data independently before making investment decisions.

Q: How accurate is the market data?
A: We use reputable sources (Yahoo Finance, Finnhub) but data may have delays. Not suitable for high-frequency trading.

Q: Can I contribute to the project?
A: Absolutely! Check our Contributing Guide to get started.

Status & Updates