spb/vquant Public MIT

1<!--2  =============================================================================3   VibeQuant (vquant) — AI-Powered Financial Intelligence Platform4  -----------------------------------------------------------------------------5   File:      docs/GETTING_STARTED.md67   Author:    Simon-Pierre Boucher8   Contact:   contact@spboucher.ai9   Website:   https://www.spboucher.ai10   Demo:      https://www.vquant.ai11   License:   MIT (see LICENSE)1213   Copyright © 2026 Simon-Pierre Boucher. All rights reserved.14  =============================================================================15-->1617# Getting Started1819Complete guide to set up and run VibeQuant locally.2021## Prerequisites2223| Requirement | Version | Purpose |24|-------------|---------|---------|25| **Node.js** | 18+ | Server & client runtime |26| **npm** | 9+ | Package manager |27| **Python** | 3.11+ | Quantitative analysis (Monte Carlo, GARCH, VaR, etc.) |28| **LaTeX** (optional) | Any | Beamer PDF slide generation |29| **Pandoc** (optional) | Any | DOCX document generation |3031## Step 1 — Clone & Install3233```bash34git clone https://github.com/spboucher-ai/vquant.git35cd vquant3637# Install Node.js dependencies38npm install39```4041## Step 2 — Python Environment4243The Python environment is required for quantitative analysis features (Monte Carlo, GARCH, VaR, portfolio optimization, custom Python code).4445```bash46# Create virtual environment47python3 -m venv .venv4849# Activate it50source .venv/bin/activate        # macOS / Linux51# .venv\Scripts\activate          # Windows5253# Install scientific libraries54pip install -r requirements-safe.txt55```5657### Included Python Libraries (17)5859| Library | Purpose |60|---------|---------|61| numpy | Numerical computing |62| pandas | Data manipulation & analysis |63| scipy | Scientific computing & statistics |64| scikit-learn | Machine learning |65| statsmodels | Statistical models |66| matplotlib | Static charts |67| seaborn | Statistical visualization |68| plotly | Interactive charts |69| arch | GARCH volatility models |70| cvxpy | Convex optimization (portfolio) |71| yfinance | Market data provider |72| ta | Technical analysis indicators |73| quantstats | Portfolio analytics |74| beautifulsoup4 | Web scraping |75| requests | HTTP client |76| lxml | XML/HTML parsing |77| Pillow | Image processing |7879## Step 3 — Environment Variables8081```bash82cp .env.example .env83```8485Edit `.env` with your API keys:8687```bash88# ─── Required ──────────────────────────────────────────89ANTHROPIC_API_KEY=sk-ant-api03-your-key-here    # Claude AI90FMP_API_KEY=your-fmp-key-here                    # Financial data9192# ─── Recommended ───────────────────────────────────────93FIRECRAWL_API_KEY=fc-your-key-here               # Web/PDF extraction94TAVILY_API_KEY=tvly-your-key-here                # AI-powered search9596# ─── Optional ──────────────────────────────────────────97EXA_API_KEY=your-exa-key-here                    # Semantic search98SERPAPI_API_KEY=your-serpapi-key-here             # Google search99ELEVENLABS_API_KEY=your-elevenlabs-key-here      # Speech-to-text100101# ─── Server Config ─────────────────────────────────────102DATABASE_URL=sqlite://local.db                   # SQLite (default) or PostgreSQL103SESSION_SECRET=generate-a-strong-random-secret   # Required in production104PORT=5000105NODE_ENV=development106```107108### Where to get API keys109110| Service | Free Tier | Sign Up |111|---------|-----------|---------|112| **Anthropic** | $5 credit | [console.anthropic.com](https://console.anthropic.com) |113| **FMP** | 250 calls/day | [financialmodelingprep.com](https://financialmodelingprep.com) |114| **Firecrawl** | 500 credits | [firecrawl.dev](https://firecrawl.dev) |115| **Tavily** | 1000 calls/month | [app.tavily.com](https://app.tavily.com) |116| **Exa** | 1000 searches/month | [exa.ai](https://exa.ai) |117| **SerpAPI** | 100 searches/month | [serpapi.com](https://serpapi.com) |118119## Step 4 — Run120121```bash122# Development (with hot-reload)123npm run dev124125# The app is available at http://localhost:5000126```127128## Step 5 — Verify1291301. Open `http://localhost:5000` in your browser1312. Type a query like: `"Analyze AAPL stock: profile, financials, and analyst ratings"`1323. Watch the AI agent execute tools and stream the response in real-time133134## Available Scripts135136| Command | Description |137|---------|-------------|138| `npm run dev` | Start dev server (Vite HMR + Express) |139| `npm run build` | Build for production |140| `npm start` | Start production server |141| `npm run typecheck` | TypeScript check |142| `npm run lint` | ESLint check |143| `npm run lint:fix` | ESLint auto-fix |144| `npm run format` | Prettier format |145| `npm test` | Run all tests |146| `npm run test:watch` | Tests in watch mode |147| `npm run db:push` | Push database schema |148149## Troubleshooting150151### Python not found152```bash153# Specify Python path explicitly in .env154PYTHON_PATH=/path/to/.venv/bin/python155```156157### Port already in use158```bash159# Change port in .env160PORT=3001161```162163### npm install peer dependency errors164```bash165npm install --legacy-peer-deps166```167