diff --git a/.github/images/readme-illustration-dark.png b/.github/images/readme-illustration-dark.png new file mode 100644 index 000000000..5da2d14bf Binary files /dev/null and b/.github/images/readme-illustration-dark.png differ diff --git a/.github/images/readme-illustration-light.png b/.github/images/readme-illustration-light.png new file mode 100644 index 000000000..628c9b974 Binary files /dev/null and b/.github/images/readme-illustration-light.png differ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..854139a31 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +# Contributing diff --git a/README.md b/README.md index dd332748c..c65751f9d 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,24 @@ -
+ -## Development (localhost) +Typebot is an open-source alternative to Landbot. It allows you to create conversational apps (Lead qualification, Product launch, User onboarding, Customer support), embed them anywhere on your web apps, and collect results in real-time. -1. Clone the repo +## Getting started with Typebot - ```sh - git clone https://github.com/Typebot-io/typebot.git - ``` +The easiest way to get started with Typebot is with [the official managed service in the Cloud](https://app.typebot.io). It takes 1 minute to try out the builder for free. You'll have high availability, backups, security, and maintenance all managed for you by me, @baptisteArno, Typebot's founder. -2. Install packages with yarn +That's also the best way to support my work, open-source software, and you'll get great service! - ```sh - yarn set version berry - yarn install - ``` +## Self-hosting -3. Copy `.env.example` to `.env` -4. Configure environment variables in the `.env` file. -5. Run the applications +Interested in self-hosting Typebot on your server? Take a look at our self-hosting installation instructions. - ```sh - yarn dx - ``` +## Technology -## Deployment - -TO-DO +Typebot is a monorepo powered by TurboRepo. Apps are built with state-of-the-art web technologies. These include Typescript, Next.js, Prisma (PostgresDB), Chakra UI, TailwindCSS.