GridWork HQ
Getting Started

Prerequisites

System requirements and accounts needed before installing GridWork HQ.

Prerequisites

Before installing GridWork HQ, make sure you have the required software and accounts ready. The setup wizard will ask for API keys during configuration — having them ready makes the process faster.

System Requirements

RequirementMinimumRecommended
Node.js20.x22.x (LTS)
Git2.30+Latest
Claude Code CLILatestLatest
RAM8 GB16 GB+
Disk10 GB free50 GB+
OSmacOS 13+ or Ubuntu 22.04+macOS 14+ or Ubuntu 24.04

Installing Node.js

# macOS (via Homebrew)
brew install node@22

# Linux (via nvm — recommended)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
source ~/.bashrc
nvm install 22
nvm use 22

Installing Claude Code CLI

npm install -g @anthropic-ai/claude-code

Required Accounts

You need API keys from these services before running the setup wizard.

ServiceRequired?What You NeedWhere to Get It
AnthropicYesAPI keyconsole.anthropic.com
GitHubYesOAuth App + Personal Access Tokengithub.com
NotionYesIntegration secret + database IDsnotion.so/my-integrations

Anthropic API Key

  1. Sign up at console.anthropic.com
  2. Navigate to API Keys
  3. Create a new key
  4. Copy it — this becomes your ANTHROPIC_API_KEY

The pipeline server uses this key to spawn Claude Code processes. The dashboard uses it for the AI chat feature. Expect costs of approximately $0.01-0.05 per chat exchange, with variable costs per pipeline run depending on the model tier used.

GitHub OAuth App

  1. Go to github.com/settings/applications/new
  2. Fill in:
    • Application name: GridWork HQ (or your agency name)
    • Homepage URL: http://localhost:3000 (update later for production)
    • Authorization callback URL: http://localhost:3000/api/auth/callback/github
  3. Click Register application
  4. Copy the Client ID and generate a Client Secret

GitHub Personal Access Token

  1. Go to github.com/settings/tokens
  2. Select scopes: repo, read:org
  3. Generate and copy the token

Notion Integration

  1. Go to notion.so/my-integrations
  2. Click New integration
  3. Name it (e.g., "GridWork HQ")
  4. Select your workspace
  5. Set capabilities: Read content, Update content, Insert content
  6. Copy the Internal Integration Secret

You will also need two Notion databases (Leads and Clients). See the Notion integration guide for database setup details.

Optional Accounts

These integrations add functionality but are not required. GridWork HQ degrades gracefully — missing keys show "Not configured" in the UI instead of crashing.

ServicePurposeWhere to Get It
VercelDashboard hosting (cloud deploy)vercel.com
StripeInvoice and revenue trackingdashboard.stripe.com
TelegramCron job and pipeline notificationsMessage @BotFather
PerplexityResearch in prospect and audit pipelinesperplexity.ai/settings/api
Google CloudPageSpeed API for site health trackingconsole.cloud.google.com
Google AnalyticsGA4 traffic data in dashboardGoogle Cloud service account
Google Search ConsoleSearch performance dataGoogle Cloud service account
UptimeRobotUptime monitoringuptimerobot.com

Optional Tools

ToolPurposeInstall
bunFaster package manager and runtimecurl -fsSL https://bun.sh/install | bash
TailscaleExpose pipeline server to Vercelbrew install tailscale or tailscale.com/download
rcloneOffsite backups to Backblaze B2brew install rclone
himalayaCLI email sync for cron jobsbrew install himalaya

Next Steps

Once you have Node.js, the Claude Code CLI, and your API keys ready, proceed to the Quick Start guide.

On this page