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
| Requirement | Minimum | Recommended |
|---|---|---|
| Node.js | 20.x | 22.x (LTS) |
| Git | 2.30+ | Latest |
| Claude Code CLI | Latest | Latest |
| RAM | 8 GB | 16 GB+ |
| Disk | 10 GB free | 50 GB+ |
| OS | macOS 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 22Installing Claude Code CLI
npm install -g @anthropic-ai/claude-codeRequired Accounts
You need API keys from these services before running the setup wizard.
| Service | Required? | What You Need | Where to Get It |
|---|---|---|---|
| Anthropic | Yes | API key | console.anthropic.com |
| GitHub | Yes | OAuth App + Personal Access Token | github.com |
| Notion | Yes | Integration secret + database IDs | notion.so/my-integrations |
Anthropic API Key
- Sign up at console.anthropic.com
- Navigate to API Keys
- Create a new key
- 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
- Go to github.com/settings/applications/new
- 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
- Click Register application
- Copy the Client ID and generate a Client Secret
GitHub Personal Access Token
- Go to github.com/settings/tokens
- Select scopes:
repo,read:org - Generate and copy the token
Notion Integration
- Go to notion.so/my-integrations
- Click New integration
- Name it (e.g., "GridWork HQ")
- Select your workspace
- Set capabilities: Read content, Update content, Insert content
- 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.
| Service | Purpose | Where to Get It |
|---|---|---|
| Vercel | Dashboard hosting (cloud deploy) | vercel.com |
| Stripe | Invoice and revenue tracking | dashboard.stripe.com |
| Telegram | Cron job and pipeline notifications | Message @BotFather |
| Perplexity | Research in prospect and audit pipelines | perplexity.ai/settings/api |
| Google Cloud | PageSpeed API for site health tracking | console.cloud.google.com |
| Google Analytics | GA4 traffic data in dashboard | Google Cloud service account |
| Google Search Console | Search performance data | Google Cloud service account |
| UptimeRobot | Uptime monitoring | uptimerobot.com |
Optional Tools
| Tool | Purpose | Install |
|---|---|---|
| bun | Faster package manager and runtime | curl -fsSL https://bun.sh/install | bash |
| Tailscale | Expose pipeline server to Vercel | brew install tailscale or tailscale.com/download |
| rclone | Offsite backups to Backblaze B2 | brew install rclone |
| himalaya | CLI email sync for cron jobs | brew install himalaya |
Next Steps
Once you have Node.js, the Claude Code CLI, and your API keys ready, proceed to the Quick Start guide.