blsmedia/bot
2
0
Fork 0
Code Activity

docs: 📝 Init cool README (WIP)

Browse Source
This commit is contained in:
Baptiste Arnaud
2022-03-03 12:14:24 +01:00
parent 31f86d8ef4
commit 63a90f2deb
4 changed files with 17 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
.github/images/readme-illustration-dark.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1000 KiB

BIN
.github/images/readme-illustration-light.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1007 KiB

1
CONTRIBUTING.md Normal file
View File

@ -0,0 +1 @@
# Contributing

52
README.md
View File

@ -1,44 +1,24 @@
<div align="center"> <p>
<h1>Typebot</h1> <a href="https://typebot.io/#gh-light-mode-only" target="_blank">
<a href="https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" /></a> <img src="./.github/readme-illustration-light.png" alt="Typebot illustration">
<a href="https://github.com/baptisteArno/typebot-io/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-AGPLv3-blue" /></a> </a>
<br /> <a href="https://typebot.io/#gh-dark-mode-only" target="_blank">
<a href="https://docs.typebot.io">Quickstart</a> <img src="./.github/readme-illustration-dark.png" alt="Typebot illustration">
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span> </a>
<a href="https://www.typebot.io/">Website</a> </p>
<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) 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 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.
git clone https://github.com/Typebot-io/typebot.git
```
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 ## Self-hosting
yarn set version berry
yarn install
```
3. Copy `.env.example` to `.env` Interested in self-hosting Typebot on your server? Take a look at our self-hosting installation instructions.
4. Configure environment variables in the `.env` file.
5. Run the applications
```sh ## Technology
yarn dx
```
## Deployment 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.
TO-DO