typebot.io README

The project's README from github.com/baptisteArno/typebot.io. As one markdown file: README.md.


Typebot banner


Typebot is a Fair Source chatbot builder. It allows you to create advanced chatbots visually, embed them anywhere on your web/mobile apps, and collect results in real-time

Github Stars Commits per month License Uptime Report a bug Ask a question

Try Typebot • Docs

Builder demo

https://user-images.githubusercontent.com/16015833/168876388-0310678d-080b-4eca-8633-e5cc4d7bd5d1.mp4

Features

Typebot makes it easy to create advanced chatbots. It provides the building blocks that are adaptable to any business use case. I improve Typebot regularly with bug fixes, new features, and performance improvements.

Chat builder with 34+ building blocks such as:

Theme your chatbot to match your brand identity:

Share your typebot anywhere:

Collect your Results and get insights:

Built for developers:

Getting started with Typebot

The easiest way to get started with Typebot is with the official managed service in the Cloud. You'll have high availability, backups, security, and maintenance all managed for you by me, Baptiste, Typebot's founder.

The cloud version can save a substantial amount of developer time and resources. For most sites, this ends up being the best value option and the revenue goes to funding the maintenance and further development of Typebot. So you’ll be supporting Fair Source software and getting a great service! 💙

Support & Community

You'll find a lot of resources to help you get started with Typebot in the documentation.

Self-hosting

Interested in self-hosting Typebot on your server? Take a look at the self-hosting installation instructions.

How to Contribute

You are awesome, let's build great software together. Head over to the Contribute docs to get started. 💪

Run the project locally

Follow the Local installation section of in the Contributing docs.

Top contributors

Made with contrib.rocks.

License

Typebot's code is protected under a Functional Source License. You will find more information about the license and how to comply with it here.

typebot.io (baptisteArno/typebot.io)

Searching Database…

What is this?Typebot is a chatbot builder you can self-host: you design advanced chatbots visually, embed them in your web or mobile apps, and collect results in real-time.
Is this a hosted service I sign up for, or something I run on my own server?It's a self-hostable web application, not a library: the repo ships the builder and bot runtime with Docker and Docker Compose configs, so you run it on your own server and use it from the browser.
How do I get my own instance running?Clone the repo and bring up the included Docker Compose stack. For development or a from-source build you use Bun, and the tooling expects Node 24.x.
What do I need installed before I can run it?Docker plus Docker Compose for self-hosting; Node 24.x and Bun if you build from source — the postinstall step also compiles an env package and generates the Prisma client.
Where can the bots I build actually run?Anywhere you can embed a snippet: the bots run inside web and mobile apps, and results stream back in real-time.
Will an ordinary VPS be enough to self-host it?Yes — it's a standard Dockerized web stack (Next.js on Node 24, database behind Prisma), so any Docker-capable VPS is enough; no GPU or special hardware involved.
Is it really open source — can I just use it however I want?Not fully: the code is under a Functional Source License (Fair Source), which permits self-hosting but carries compliance conditions — it isn't OSI open source, so review the terms before commercial use.
Do I need to know how to code to build a bot?No — bots are assembled visually in the builder. Coding only comes in on the self-hosting side: Docker, environment configuration and building the app from source with Bun.
Why Fair Source instead of a standard MIT license?Fair Source keeps the code readable and self-hostable while preserving some commercial control for the vendor; the README points to the Functional Source License docs and asks users to check the compliance terms.
What is the stack under the hood?A TypeScript monorepo: Next.js and Tailwind CSS on the front, Node 24.x at runtime, Bun for tooling, Prisma for database access, and Docker Compose for deployment.
What are similar projects?sim, formily, formbricks, sphere, whirl, apitable, seerr, LoomFlow
Size
394.3 MB
Stars
10.6K
Age
4y
Commits · 90 Days