Install the project locally

​

Get started

1. Fork this repository to your own GitHub account and then clone it to your local device.

​

Running the project locally

1. Make sure you have node, bun and docker installed. For node, I suggest you use proto or nvm allowing you to manage different versions. It should then autodetect which version need to be installed before running any command.

2. Install dependencies

   cd typebot.io
   bun install
   

3. Set up environment variables

   Copy .env.dev.example to .env

   Check out the Configuration guide if you want to enable more options

4. If you use the default DATABASE_URL, you need a matching database running. You can do that easily with the provided docker-compose.dev.yml file:

   docker compose -f docker-compose.dev.yml up -d
   

   This will also create a minio instance to enable file uploads.

5. Start the builder and viewer

   bun dev
   

   Builder is available at http://localhost:3000

   Viewer is available at http://localhost:3001

   By default, you can easily authenticate in the builder using the “Github Sign In” button. For other options, check out the Configuration guide. If you want to skip authentication or you want to run the e2e tests, you can set NEXT_PUBLIC_E2E_TEST to true in the .env file.

6. Optionnally you can also run the other available apps:

   For the landing page:

   bunx turbo dev --filter=landing-page
   

   For the docs:

   bunx turbo dev --filter=docs