setup.md

📋 Setup

🔧 Tooling

Download and Install the following

• Just
• Docker Desktop
• Node.js (LTS recommended)

🛠️ IDE Setup

You can use any editor, but setup instructions are included for two popular IDEs:

• WebStorm
• Visual Studio Code

🌳 Environment

• Run just setup in the terminal to create your .env file and install dependencies.
  • You can edit the .env manually anytime to change the default values.

🏃‍♂️ Running

• 🐳 Docker: Run just start in the terminal (RECOMMENDED).
• 🏠 Local: Run just start -l in the terminal.

📦 Packages

This project uses a variety of packages for scraping, browser automation, AI summarization, Excel handling, React frontend, and concurrency control.

• Parsing & Dates

  • Chrono-Node – Natural language date parser for extracting dates from text.
  • Date-FNS – Modern JavaScript date utility library for formatting, comparisons, and calculations.

• Environment

  • Dotenv – Loads environment variables from a .env file.

• Scraping & Browser Automation

  • Playwright – Browser automation library for headless and headed browsing.
  • Playwright-Extra – Extensible version of Playwright to use plugins.
  • Puppeteer-Extra-Plugin-Stealth – Helps evade bot detection for automated browsers.

• Excel Handling

  • ExcelJS – Read and write Excel (.xlsx) spreadsheets entirely in Node.js.

• AI Integration

  • @google/genai – SDK for Google Gemini / Generative AI models, used for summarizing reports.

• Async Control

  • @supercharge/promise-pool – Manage concurrent async tasks with controlled concurrency.
  • TinyQueue – Fast priority queue for JavaScript, used for ordered processing of tasks.

• Search & Data Fetching

  • SerpAPI – API for scraping Google search results, including Google Maps business listings.

• Database & File Uploads

  • @prisma/client – Type-safe database client for Node.js and TypeScript.
  • Multer – Middleware for handling multipart/form-data, primarily used for file uploads in Express.

• Styling & Frontend

  • Bootstrap – CSS framework used for form styling and layout.
  • React – Library for building user interfaces.
  • React-DOM – Provides DOM-specific methods for React.
  • React-Bootstrap – React components for Bootstrap.
  • React-Router-DOM – Routing library for React single-page applications.
  • React-Leaflet – React wrapper for Leaflet maps.
  • Leaflet – Core mapping library used by React-Leaflet.
  • React-Markdown – Render Markdown content as React components.

• Server & Templates

  • Express – Fast, minimal Node.js web framework.