mirror of
https://github.com/formbricks/formbricks.git
synced 2026-05-09 11:10:36 -05:00
Matti Nannt
57 lines
1.4 KiB
Plaintext
57 lines
1.4 KiB
Plaintext
---
|
|
title: GitHub Codespaces
|
|
description: How to set up Formbricks in a GitHub Codespaces environment
|
|
icon: "github"
|
|
---
|
|
|
|
### 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
|
|
git clone https://github.com/formbricks/formbricks && cd formbricks
|
|
```
|
|
|
|
2. **Setup NodeJS with nvm (if not already configured):**
|
|
|
|
```bash
|
|
nvm install && nvm use
|
|
```
|
|
|
|
3. **Install the dependencies:**
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
4. **Create a development `.env` file and generate the required secrets:**
|
|
|
|
```bash
|
|
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
|
|
pnpm agents:update
|
|
```
|
|
|
|
6. **Launch the development setup:**
|
|
```bash
|
|
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>
|