Getting Started

Welcome to the Financial Data Extractor! This guide will help you get up and running quickly.

Quick Start

The fastest way to get started:

# Clone the repository
git clone https://github.com/PatrykQuantumNomad/financial-data-extractor.git
cd financial-data-extractor

# ⚠️ CRITICAL: Configure environment variables FIRST
# Backend: Copy .env.example to .env and configure
cd backend
cp .env.example .env
# Edit .env and set OPEN_ROUTER_API_KEY and other required values

# Frontend: Copy .env.example to .env and configure
cd ../frontend
cp .env.example .env
# Edit .env if you need to change API URL or other settings

# Start infrastructure services (PostgreSQL, Redis, MinIO, monitoring)
cd ../infrastructure
make up-dev

# Setup backend
cd ../backend
make install-dev
make migrate

# Start backend server (in one terminal)
make run

# Start Celery worker (in another terminal)
make celery-worker

# Setup frontend (in a third terminal)
cd ../frontend
npm install
npm run dev

Access Points:

  • Frontend: http://localhost:3000
  • Backend API: http://localhost:3030
  • API Docs: http://localhost:3030/docs
  • Grafana: http://localhost:3200 (admin/admin)
  • Flower: http://localhost:5555
  • MinIO Console: http://localhost:9001 (minioadmin/minioadmin)

Next Steps

  1. Installation Guide - Detailed setup instructions and prerequisites
  2. First Extraction - Tutorial for your first financial data extraction

Documentation

For detailed information, see:

Table of contents