blsmedia/bot
2
0
Fork 0
Code Activity

docs: 📝 Update README and contribution instructions

Browse Source
This commit is contained in:
Baptiste Arnaud
2022-03-12 10:28:04 +01:00
parent e886d1b079
commit b37db3cee3
2 changed files with 38 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@ -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
README.md
View File

@ -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
@ -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
Builder is available at `http://localhost:3000`
5. Start the applications:
Viewer is available at `http://localhost:3001`
```sh
yarn dev
```
Database inspector is available at `http://localhost:5555`
Builder will be available at `http://localhost:3000`
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)
Viewer will be available at `http://localhost:3001`
## Contribute
Database inspector will be available at `http://localhost:5555`
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