• Stars
    star
    6,854
  • Rank 5,746 (Top 0.2 %)
  • Language
    TypeScript
  • License
    Other
  • Created almost 3 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

πŸ’¬ Typebot is a powerful chatbot builder that you can self-host.

Typebot illustration Typebot illustration

demo.mp4

Typebot is an open-source alternative to Landbot. It allows you to create conversational apps/forms (Lead qualification, Product launch, User onboarding, Customer support), embed them anywhere on your web/mobile apps, and collect results in real-time.

Features

  • Text, image, video bubble messages
  • Text, URL, email, phone number, date... input fields
  • Native integrations including Google Sheets, Webhooks, Send email (more to come)
  • Conditional branching, URL redirections
  • Beautiful animations
  • Theme is 100% customizable
  • Embed as a container, popup, or chat bubble easily with the native JS library
  • In-depth analytics

For more info, visit the landing page

Stay up-to-date

Lots of new features are being implemented on a day-to-day basis. Make sure to hit the Star button and watch Releases to be notified of future features.

Typebot illustration

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 open source software and getting a great service! πŸ’™

Self-hosting

Typebot is fully open source and we allow you to self-host your own version as long as you respect the License. Your version would be the same product as Typebot Cloud. There is no limitations in terms of available features.

The main difference between the two is that with the self-hosted version you have to install, host and manage yourself on your own infrastructure while the cloud version we manage everything for your ease and convenience. Here's the overview of all the differences:

Typebot Cloud Self-Hosting
Hosting Easy and convenient. It takes 1 minute to start building your bots and share them with a worldwide high availability, backups, security and maintenance all done for you by me, Baptiste, Typebot's founder. I manage everything so you don’t have to worry about anything and can focus on creating great bot experiences. You do it all yourself. You need to get a server and you need to manage your infrastructure. You are responsible for installation, maintenance, upgrades, server capacity, uptime, backup, security, stability, consistency, loading time and so on.
Storage All visitor data is exclusively processed on EU-owned cloud infrastructure. This ensures that your bots data processing complies with GDPR. You have full control and can host your instance on any server in any country that you wish. Host it on a server in your basement or host it with any cloud provider wherever you want.
Costs I charge a subscription fee. Whether you're a solo business owner, a growing startup or a large company, Typebot is here to help you build high-performing chat forms for the right price. Pay for as little or as much usage as you need. You need to pay for your server, your database, your S3 storage, backups and whatever other cost there is associated with running the infrastructure. You never have to pay any fees to us.

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

Local setup

  1. Clone the repo

    git clone https://github.com/baptisteArno/typebot.io.git
  2. Install dependencies

    cd typebot.io
    pnpm i
  3. Set up environment variables

    Copy apps/builder/.env.local.example to apps/builder/.env.local

    Copy apps/viewer/.env.local.example to apps/viewer/.env.local

    Copy packages/prisma/.env.example to packages/prisma/.env

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

  4. Make sure you have Docker running

  5. Start the builder and viewer

    pnpm dev

    Builder is available at http://localhost:3000

    Viewer is available at http://localhost:3001

    Database inspector is available at http://localhost:5555

    By default, you can easily authenticate in the builder using the "Github Sign In" button. For other options, check out the Configuration guide

  6. (Optionnal) Start the landing page

    Copy apps/landing-page/.env.local.example to apps/landing-page/.env.local

    cd apps/landing-page
    pnpm dev
  7. (Optionnal) Start the docs

    cd apps/docs
    pnpm start

Contribute

Another great way to support Typebot is to contribute to the project. Head over to the Contribute guidelines to get started. 😍

Technology

Typebot is a Monorepo powered by Turborepo. It is composed of 2 main applications:

  • the builder, where you build your typebots
  • the viewer, where your user answer the typebot

These apps are built with awesome web technologies including Typescript, Next.js, Prisma, Chakra UI, Tailwind CSS.

License

Typebot is open-source under the GNU Affero General Public License Version 3 (AGPLv3). You can find it here.

The goal of the AGPL license is to:

  • Maximize user freedom and to encourage companies to contribute to open source.
  • Prevent corporations from taking the code and using it as part of their closed-source proprietary products
  • Prevent corporations from offering Typebot as a service without contributing to the open source project
  • Prevent corporations from confusing people and making them think that the service they sell is in any shape or form approved by the original team

Here are the 3 different possible use cases:

You'd like to self-host Typebot as-is without modifying the source code and you don't have the intention on commercializing your version of Typebot.

You can host and use Typebot without restrictions. Your contributions to improve Typebot and fix bugs are welcome. πŸ’™

You'd like to fork the project to build your own features on top of Typebot and you don't have the intention on commercializing your version of Typebot.

You need to open-source your modifications

You'd like to commercialize your own version of Typebot

You need to open-source your modifications and after your users registration, they should see a prominent mention and link to the original project (https://typebot.io). You should clearly mention that you provide a modified version. It's a good place to explain your version advantages comparing to the original project.