Skip to content

Commit

Permalink
docs: 📝 Update README and contribution instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
baptisteArno committed Mar 12, 2022
1 parent e886d1b commit b37db3c
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 15 deletions.
26 changes: 25 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
# Contributing
# Contributing to Typebot

You are considering contributing to Typebot. I thank you for this 🙏.

Any contributions you make are **greatly appreciated**. It can be anything from typo fixes to new features.

Let's [discuss](https://github.com/baptisteArno/typebot.io/discussions/new) about what you want to implement before creating a PR if you are unsure about the requirements or the vision of Typebot.

## Get started

1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your
own GitHub account and then
[clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.

2. Create a new branch:

```sh
git checkout -b MY_BRANCH_NAME
```

3. Follow [Local setup instructions](https://github.com/baptisteArno/typebot.io#local-setup)

Ideally, new features should have e2e tests. Check out existing tests in `/apps/builder/playwright/tests` and `/apps/viewer/playwright/tests`.

If you struggle writing new tests you can still create a WIP Pull request and I will help you 😃
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
</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.
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
- 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
Expand Down Expand Up @@ -48,27 +48,26 @@ Interested in self-hosting Typebot on your server? Take a look at the [self-host

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

3. Install packages and start the applications.
Check out the [Configuration guide](https://docs.typebot.io/self-hosting/configuration) if you want to enable more options

3. Make sure you have [Docker](https://docs.docker.com/compose/install/) running
4. Start the applications.

```sh
yarn
yarn && yarn dev
```

4. Make sure your have [docker-compose](https://docs.docker.com/compose/install/) installed

5. Start the applications:
Builder is available at `http://localhost:3000`

```sh
yarn dev
```
Viewer is available at `http://localhost:3001`

Builder will be available at `http://localhost:3000`
Database inspector is available at `http://localhost:5555`

Viewer will be 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](https://docs.typebot.io/self-hosting/configuration)

Database inspector will be available at `http://localhost:5555`
## Contribute

By default, you can easily authenticate in the builder using the "Github Sign In" button.
Another great way to support Typebot is to contribute to the project. Head over to the [Contribute guidelines](https://github.com/baptisteArno/typebot.io/blob/main/CONTRIBUTING.md) to get started. 😍

## Technology

Expand Down

2 comments on commit b37db3c

@vercel
Copy link

@vercel vercel bot commented on b37db3c Mar 12, 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

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

Please sign in to comment.