Skip to content

Commit b37db3c

Browse files
committed
docs: 📝 Update README and contribution instructions
1 parent e886d1b commit b37db3c

File tree

2 files changed

+38
-15
lines changed

2 files changed

+38
-15
lines changed

CONTRIBUTING.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
1-
# Contributing
1+
# Contributing to Typebot
2+
3+
You are considering contributing to Typebot. I thank you for this 🙏.
4+
5+
Any contributions you make are **greatly appreciated**. It can be anything from typo fixes to new features.
6+
7+
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.
8+
9+
## Get started
10+
11+
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your
12+
own GitHub account and then
13+
[clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
14+
15+
2. Create a new branch:
16+
17+
```sh
18+
git checkout -b MY_BRANCH_NAME
19+
```
20+
21+
3. Follow [Local setup instructions](https://github.com/baptisteArno/typebot.io#local-setup)
22+
23+
Ideally, new features should have e2e tests. Check out existing tests in `/apps/builder/playwright/tests` and `/apps/viewer/playwright/tests`.
24+
25+
If you struggle writing new tests you can still create a WIP Pull request and I will help you 😃

README.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
</a>
88
</p>
99

10-
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.
10+
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.
1111

1212
## Features
1313

1414
- Text, image, video bubble messages
15-
- Text, URL, email, phone number, date input fields
15+
- Text, URL, email, phone number, date... input fields
1616
- Native integrations including Google Sheets, Webhooks, Send email (more to come)
1717
- Conditional branching, URL redirections
1818
- Beautiful animations
@@ -48,27 +48,26 @@ Interested in self-hosting Typebot on your server? Take a look at the [self-host
4848

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

51-
3. Install packages and start the applications.
51+
Check out the [Configuration guide](https://docs.typebot.io/self-hosting/configuration) if you want to enable more options
52+
53+
3. Make sure you have [Docker](https://docs.docker.com/compose/install/) running
54+
4. Start the applications.
5255

5356
```sh
54-
yarn
57+
yarn && yarn dev
5558
```
5659

57-
4. Make sure your have [docker-compose](https://docs.docker.com/compose/install/) installed
58-
59-
5. Start the applications:
60+
Builder is available at `http://localhost:3000`
6061

61-
```sh
62-
yarn dev
63-
```
62+
Viewer is available at `http://localhost:3001`
6463

65-
Builder will be available at `http://localhost:3000`
64+
Database inspector is available at `http://localhost:5555`
6665

67-
Viewer will be available at `http://localhost:3001`
66+
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)
6867

69-
Database inspector will be available at `http://localhost:5555`
68+
## Contribute
7069

71-
By default, you can easily authenticate in the builder using the "Github Sign In" button.
70+
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. 😍
7271

7372
## Technology
7473

0 commit comments

Comments
 (0)