Skip to content

getting-started.md

Latest commit

 

History

History
35 lines (22 loc) · 671 Bytes

getting-started.md

File metadata and controls

35 lines (22 loc) · 671 Bytes

Getting Started

This tutorial starts PatchHound locally with Docker so you can explore the full stack quickly.

Prerequisites

  • Docker Desktop or a compatible Docker engine
  • A copy of .env.example saved as .env

Steps

  1. Create the local environment file:
cp .env.example .env

  1. Fill in the required values in .env.

  2. Start the stack:

docker compose up -d --build
  1. Open the application:
  • Frontend: http://localhost:3000
  • API: http://localhost:8080

What To Check

  • The API container starts without configuration errors.
  • The frontend loads and can authenticate.
  • Worker services stay healthy after startup.