Back to Explorer

Project Documentation

Technical overview and architecture

Architecture

  • Frontend: Next.js (App Router), Tailwind
  • Backend: NestJS, TypeScript
  • Scraping: Playwright (Headless)
  • Database: SQLite (Local)

    • Getting Started

    # Backend Setup

    cd backend

    npm install

    npm run start:dev # Runs at :3000

    # Frontend Setup

    cd frontend

    npm install

    npm run dev # Runs at :3001

    Environment Variables

    The system relies on specific environment configurations. Ensure .env files are correctly set based on the provided .env.example templates in both directories.