Skip to content

Commit

Permalink
docs: add lp and docs start instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
baptisteArno committed Jul 26, 2022
1 parent 7d0a526 commit 22eb48b
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 6 deletions.
31 changes: 27 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,26 @@ Interested in self-hosting Typebot on your server? Take a look at the [self-host
git clone https://github.com/baptisteArno/typebot.io.git
```

2. Set up environment variables
2. Install dependencies

```sh
cd typebot.io
yarn
```

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`

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.
4. Make sure you have [Docker](https://docs.docker.com/compose/install/) running
5. Start the builder and viewer

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

Builder is available at `http://localhost:3000`
Expand All @@ -73,6 +80,22 @@ Interested in self-hosting Typebot on your server? Take a look at the [self-host

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
yarn dev
```

7. (Optionnal) Start the docs

```sh
cd apps/docs
yarn 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. 😍
Expand Down
2 changes: 0 additions & 2 deletions apps/landing-page/.env.local.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
NOTION_API_TOKEN=
NOTION_DATABASE_ID=
NEXT_PUBLIC_VIEWER_URL=http://localhost:3001
LANDING_PAGE_HOST=http://localhost:3002

4 comments on commit 22eb48b

@vercel
Copy link

@vercel vercel bot commented on 22eb48b Jul 26, 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:

docs – ./apps/docs

docs-git-main-typebot-io.vercel.app
docs.typebot.io
docs-typebot-io.vercel.app

@vercel
Copy link

@vercel vercel bot commented on 22eb48b Jul 26, 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:

viewer-v2-alpha – ./apps/viewer

8jours.top
finplex.be
247987.com
bot.aipr.kr
bot.aws.bj
sat.cr8.ai
an.nigerias.io
am.nigerias.io
vhpage.cr8.ai
bt.id8rs.com
ticketfute.com
apr.nigerias.io
apo.nigerias.io
bot.lalmon.com
ar.nigerias.io
aso.nigerias.io
games.klujo.com
chat.sureb4.com
sakuranembro.it
eventhub.com.au
bot.piccinato.co
bot.upfunnel.art
clo.closeer.work
kw.wpwakanda.com
faqs.nigerias.io
voicehelp.cr8.ai
stan.vselise.com
feedback.ofx.one
app.chatforms.net
bot.agfunnel.tech
gentleman-shop.fr
k1.kandabrand.com
bot.maitempah.com
bot.phuonghub.com
lb.ticketfute.com
ov2.wpwakanda.com
ov3.wpwakanda.com
goalsettingbot.com
ov1.wpwakanda.com
1988.bouclidom.com
carsalesenquiry.com
this-is-a-test.com
zap.techadviser.in
forms.webisharp.com
bot.digitalbled.com
bot.eventhub.com.au
typebot.stillio.com
order.maitempah.com
bium.gratirabbit.com
bot.ansuraniphone.my
connect.growthguy.in
bot.cotemeuplano.com
chat.hayurihijab.com
aidigitalmarketing.kr
get.freebotoffer.xyz
abutton.wpwakanda.com
cdd.searchcube.com.sg
bot.meuesocial.com.br
bbutton.wpwakanda.com
bot.incusservices.com
sbutton.wpwakanda.com
bbutton.wpwwakanda.com
apply.ansuraniphone.my
chat.missarkansas.org
felipewelington.com.br
c23111azqw.nigerias.io
form.searchcube.com.sg
gcase.barrettamario.it
info.clickasuransi.com
kodawariab736.skeep.it
report.gratirabbit.com
view.onlinebotdemo.xyz
bot.blackboxtips.com.br
83242573.actualizar.xyz
resume.gratirabbit.com
mainmenu.diddancing.com
bot.upgradesolutions.eu
signup.hypemarketing.in
survey.hypemarketing.in
subfooter.wpwakanda.com
91181264.your-access.one
form.sergiolimajr.com.br
hunterbot.saleshunter.ai
bot.blackboxsports.com.br
type.opaulovieira.com.br
bot.aidigitalmarketing.kr
aibot.angrybranding.co.uk
bot.cabinrentalagency.com
boyfriend-breakup.riku.ai
chat.thisiscrushhouse.com
sellmyharleylouisiana.com
verfica.botmachine.com.br
designguide.techyscouts.com
presente.empresarias.com.mx
piazzatorre.barrettamario.it
type.dericsoncalari.com.br
sell.sellthemotorhome.co.uk
onboarding.libertydreamcare.ie
type.talitasouzamarques.com.br
agendamento.sergiolimajr.com.br

@vercel
Copy link

@vercel vercel bot commented on 22eb48b Jul 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vercel
Copy link

@vercel vercel bot commented on 22eb48b Jul 26, 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

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

Please sign in to comment.