An open API service indexing awesome lists of open source software.

https://github.com/chatbotkit/template-nextjs-generative-ui-js

This repository is a template to help you quickly start your next Generative UI project using Node.js, ChatBotKit and JavaScript.
https://github.com/chatbotkit/template-nextjs-generative-ui-js

Last synced: 8 months ago
JSON representation

This repository is a template to help you quickly start your next Generative UI project using Node.js, ChatBotKit and JavaScript.

Awesome Lists containing this project

README

          

# Generative UI Template for Next.js / ChatBotKit / JS

This repository is a template to help you quickly start your next Generative UI project using Node.js, ChatBotKit and JavaScript.

## Technology Stack

- **ChatBotKit SDK**: For building the chatbot logic and handling conversation flow.
- **React**: For UI components that interact with the user, such as forms for capturing appointment details and slot selection.
- **Next.js**: The application environment.

## Setup

### Automated Setup

1. `npx create-cbk-app`
2. Follow the promts
3. Install dependencies by running npm install.
4. Set the `CHATBOTKIT_API_SECRET` environment variable with your ChatBotKit API secret.
5. Optionally, set the `CHATBOTKIT_MODEL` environment variable to specify the model used for conversation (default is GPT-3.5 Turbo).

### Manual Setup

1. Ensure you have Node.js installed.
2. Clone this repository.
3. Install dependencies by running npm install.
4. Set the `CHATBOTKIT_API_SECRET` environment variable with your ChatBotKit API secret.
5. Optionally, set the `CHATBOTKIT_MODEL` environment variable to specify the model used for conversation (default is GPT-3.5 Turbo).

## Usage

Run the development server:

```bash
npm run dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## Learn More

To learn more about ChatBotKit and relevent SDKs look at the following resources:

- [ChatBotKit Documentation](https://chatbotkit.com/docs) - learn about ChatBotKit
- [ChatBotKit JavaScript SDKs](https://github.com/chatbotkit/node-sdk) - learn about used SDKs

## Deployment

The easiest way to deploy this Next.js app is to use the [Vercel Platform](https://vercel.com).

## Contributing

Contributions to enhance the chatbot's functionality or address issues are welcome. Please follow the standard pull request process for contributions.

## License

This project is licensed under the MIT License - see the LICENSE file for details.