Skip to content

Commit

Permalink
docs: 📝 Init cool README (WIP)
Browse files Browse the repository at this point in the history
  • Loading branch information
baptisteArno committed Mar 3, 2022
1 parent 31f86d8 commit 63a90f2
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 44 deletions.
Binary file added .github/images/readme-illustration-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/readme-illustration-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Contributing
68 changes: 24 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,24 @@
<div align="center">
<h1>Typebot</h1>
<a href="https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" /></a>
<a href="https://github.com/baptisteArno/typebot-io/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-AGPLv3-blue" /></a>
<br />
<a href="https://docs.typebot.io">Quickstart</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://www.typebot.io/">Website</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://docs.typebot.io">Docs</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://www.typebot.io/blog">Blog</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://twitter.com/Typebot_io">Twitter</a>
<br />
<hr />
</div>

## Development (localhost)

1. Clone the repo

```sh
git clone https://github.com/Typebot-io/typebot.git
```

2. Install packages with yarn

```sh
yarn set version berry
yarn install
```

3. Copy `.env.example` to `.env`
4. Configure environment variables in the `.env` file.
5. Run the applications

```sh
yarn dx
```

## Deployment

TO-DO
<p>
<a href="https://typebot.io/#gh-light-mode-only" target="_blank">
<img src="./.github/readme-illustration-light.png" alt="Typebot illustration">
</a>
<a href="https://typebot.io/#gh-dark-mode-only" target="_blank">
<img src="./.github/readme-illustration-dark.png" alt="Typebot illustration">
</a>
</p>

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.

## Getting started with Typebot

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.

That's also the best way to support my work, open-source software, and you'll get great service!

## Self-hosting

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

## Technology

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.

2 comments on commit 63a90f2

@vercel
Copy link

@vercel vercel bot commented on 63a90f2 Mar 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vercel
Copy link

@vercel vercel bot commented on 63a90f2 Mar 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

builder-v2 – ./apps/builder

builder-v2-typebot-io.vercel.app
app.typebot.io
builder-v2-git-main-typebot-io.vercel.app

Please sign in to comment.