@freeday-ai/webchat NPM

Freeday webchat app

This repo contains the code for the webchat app that is rendered in an iframe in the Freeday webchat widget. (See https://github.com/freeday-ai/cx-api/tree/master/webchat-widget for more details.)

Getting Started

Enable Corepack and install the required package managers with:

corepack enable

Then start the Next.js server:

pnpm run dev

This will start the app at http://localhost:8080.

You can start editing the page by modifying the components in the /pages directory. The page auto-updates as you edit the file.

Development

The easiest way to develop within this repo is by running it alongside the @freeday-ai/webchat-widget repo. See the instructions there for more information: https://freeday.me/docs

Webchat library development

This source code can also be shipped as a library of web components and then injected into other websites. We refer to this as a webchat-library. To use it as a library run the below commands

Create environment cp .sample.env .env
Start it locally with pnpm lib:dev
Go to http://localhost:3001

Webchat library deployment

There are 2 ways to test your changes before going to production.

Beta deployment
1. Deploy your branch via Beta deployment job
2. Test it on the following beta url
3. This url only connects to Beta environment
Branch preview deployment
1. Deploy your branch via Webchat branch preview deployment
2. Give a name to your preview e.g. my-awesome-feature
3. Once deployed you will get a special url in the following format https://freeday-beta-webchat-app-my-awesome-feature.web.app
4. This URL can be shared with designers, product, other team members etc.
5. This URL connects to our production backend environment! Only use acceptance bots for testing!
6. Use a token from production e.g. for Aixigo acceptance https://freeday-beta-webchat-app-my-awesome-feature.web.app?token=6d8d1132-2496-41fe-a3f8-c3d7c7fe6410