Skip to main content

​
Gitpod Setup

This guide explains how to set up Formbricks in a Gitpod workspace.
Requirements:
  • A Gitpod workspace with Node.JS, pnpm, and Docker support.
Steps:
  1. Open the repository in Gitpod. The workspace typically clones the repo automatically. If not: 
    git clone https://github.com/formbricks/formbricks && cd formbricks
  2. Setup NodeJS with nvm: 
    nvm install && nvm use
  3. Install dependencies: 
    pnpm install
  4. Create a .env file: 
    cp .env.example .env
  5. Generate & set secret values: 
    sed -i '/^ENCRYPTION_KEY=/c\ENCRYPTION_KEY='$(openssl rand -hex 32) .env
sed -i '/^NEXTAUTH_SECRET=/c\NEXTAUTH_SECRET='$(openssl rand -hex 32) .env
sed -i '/^CRON_SECRET=/c\CRON_SECRET='$(openssl rand -hex 32) .env
  6. Generate the Next.js AGENTS.md file (optional, for AI-assisted development): This step generates an AGENTS.md file at the repository root that provides Next.js documentation context for AI coding assistants (e.g. Cursor, GitHub Copilot). It runs npx @next/codemod agents-md under the hood. Re-run it whenever you upgrade Next.js. 
    pnpm agents:update
  7. Run the development setup: 
    pnpm go
Access the running app via the forwarded port (typically http://localhost:3000 inside Gitpod).
Check your Gitpod settings to ensure Docker is enabled if required.