From 22eb48be0b9222152c8836cdd937bf1f135ba54a Mon Sep 17 00:00:00 2001 From: Baptiste Arnaud Date: Tue, 26 Jul 2022 07:53:09 +0200 Subject: [PATCH] docs: add lp and docs start instructions --- README.md | 31 ++++++++++++++++++++++++---- apps/landing-page/.env.local.example | 2 -- 2 files changed, 27 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 24d07c9ee1..566ae09fab 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,14 @@ 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` @@ -58,11 +65,11 @@ Interested in self-hosting Typebot on your server? Take a look at the [self-host 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` @@ -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. 😍 diff --git a/apps/landing-page/.env.local.example b/apps/landing-page/.env.local.example index 6ff9d31af2..9b67d9b54a 100644 --- a/apps/landing-page/.env.local.example +++ b/apps/landing-page/.env.local.example @@ -1,4 +1,2 @@ -NOTION_API_TOKEN= -NOTION_DATABASE_ID= NEXT_PUBLIC_VIEWER_URL=http://localhost:3001 LANDING_PAGE_HOST=http://localhost:3002 \ No newline at end of file