> ## Documentation Index
> Fetch the complete documentation index at: https://formbricks.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub Codespaces

> How to set up Formbricks in a GitHub Codespaces environment

### GitHub Codespaces Setup

<Info>This guide outlines how to set up Formbricks in a **GitHub Codespaces** environment.</Info>

**Requirements:**

* A GitHub Codespace that has support for Node.JS, pnpm, and Docker.

**Steps:**

1. **Open your repository in GitHub Codespaces. If needed, clone the repository:**

   ```bash theme={null}
   git clone https://github.com/formbricks/formbricks && cd formbricks
   ```

2. **Setup NodeJS with nvm (if not already configured):**

   ```bash theme={null}
   nvm install && nvm use
   ```

3. **Install the dependencies:**

   ```bash theme={null}
   pnpm install
   ```

4. **Create a development `.env` file and generate the required secrets:**

   ```bash theme={null}
   pnpm dev:setup
   ```

5. **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.

   ```bash theme={null}
   pnpm agents:update
   ```

6. **Launch the development setup:**
   ```bash theme={null}
   pnpm go
   ```

Use the Codespaces port forwarding to access Formbricks at [http://localhost:3000](http://localhost:3000).

<Tip>Make sure your Codespaces port configuration is set to allow access to the app.</Tip>