## 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, Baptiste, 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 the [self-hosting installation instructions](https://docs.typebot.io/self-hosting).
## Local setup
1. Clone the repo
```sh
git clone https://github.com/baptisteArno/typebot.io.git
```
2. Install dependencies
```sh
cd typebot.io
pnpm i
```
3. Set up environment variables
Copy `apps/builder/.env.local.example` to `apps/builder/.env.local`
Copy `apps/viewer/.env.local.example` to `apps/viewer/.env.local`
Copy `packages/db/.env.example` to `packages/db/.env`
Check out the [Configuration guide](https://docs.typebot.io/self-hosting/configuration) if you want to enable more options
4. Make sure you have [Docker](https://docs.docker.com/compose/install/) running
5. Start the builder and viewer
```sh
pnpm dev
```
Builder is available at `http://localhost:3000`
Viewer is available at `http://localhost:3001`
Database inspector is available at `http://localhost:5555`
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)
6. (Optionnal) Start the landing page
Copy `apps/landing-page/.env.local.example` to `apps/landing-page/.env.local`
```sh
cd apps/landing-page
pnpm dev
```
7. (Optionnal) Start the docs
```sh
cd apps/docs
pnpm start
```
## Contribute
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
Typebot is a Monorepo powered by [Turborepo](https://turborepo.org/). It is composed of 2 main applications:
- the builder, where you build your typebots
- the viewer, where your user answer the typebot
These apps are built with awesome web technologies including [Typescript](https://www.typescriptlang.org/), [Next.js](https://nextjs.org/), [Prisma](https://www.prisma.io/), [Chakra UI](https://chakra-ui.com/), [Tailwind CSS](https://tailwindcss.com/).
## License
Typebot is open-source under the GNU Affero General Public License Version 3 (AGPLv3). You can find it [here](./LICENSE).
The goal of the AGPL license is to:
- Maximize user freedom and to encourage companies to contribute to open source.
- Prevent corporations from taking our code and using it as part of their closed-source proprietary products
- Prevent corporations from offering Typebot as a service without contributing to the open source project
- Prevent corporations from confusing people and making them think that the service they sell is in any shape or form approved by the original team
In a few words, to use Typebot in your company, you need to:
- Open source and publish your modifications
- If you commercialize your version of Typebot, be clear and provide a prominent mention and link to the original project so people that are considering using their version of the software can be aware of the original project.
If you'd like to use Typebot without open-sourcing your modified code, you can purchase a commercial license to remove the copyleft restrictions and in that way support the original project. Contact me at baptiste@typebot.io.