https://github.com/yugasun/chatbot

ChatBot is a chat robot that simplifies the usage of chat GPT tools like ChatGPT, and can be integrated into any framework (e.g., Vue, React, Angular) for easy implementation.
https://github.com/yugasun/chatbot

aigc chatbot chatgpt lit-element web-components

Last synced: about 2 months ago
JSON representation

ChatBot is a chat robot that simplifies the usage of chat GPT tools like ChatGPT, and can be integrated into any framework (e.g., Vue, React, Angular) for easy implementation.

• Host: GitHub
• URL: https://github.com/yugasun/chatbot
• Owner: yugasun
• License: apache-2.0
• Created: 2023-05-31T09:49:10.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-19T08:10:41.000Z (almost 3 years ago)
• Last Synced: 2024-04-11T01:20:28.438Z (about 2 years ago)
• Topics: aigc, chatbot, chatgpt, lit-element, web-components
• Language: TypeScript
• Homepage: https://chatbot-yugasun.vercel.app
• Size: 736 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ChatBot

[![npm](https://img.shields.io/npm/v/@yugasun/chatbot)](https://www.npmjs.com/)

![GitHub Repo stars](https://img.shields.io/github/stars/yugasun/chatbot?style=social)

[![Lit](https://img.shields.io/badge/Framework-Lit-5865f2)](https://lit.dev/)

[![TypeScript](https://img.shields.io/badge/Language-TypeScript-blue)](https://www.typescriptlang.org/)

[![Vite](https://img.shields.io/badge/Develop-Vite-747bff)](https://vitejs.dev)

[![Build](https://github.com/yugasun/chatbot/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/yugasun/chatbot/actions/workflows/deploy.yml)

ChatBot is a chat robot that simplifies the usage of chat GPT tools like ChatGPT, and can be integrated into any framework (e.g., Vue, React, Angular) for easy implementation.

## Feature

-   [x] 🚀 Can be used in any framework, such as Vue, React, Angular, etc.

-   [x] 🌟 Works with CDNs

-   [x] 🎨 Customizable style

-   [x] 🍺 Type safe with TypeScript

-   [ ] 🌍 I18n ready

## Demo

[Live Demo](https://chatbot-yugasun.vercel.app/)



## Usage

### For framework use (Vue, React, Angular, etc.)

Install

```bash

pnpm install @yugasun/chatbot

```

Then import it in entry file:

```js

import '@yugasun/chatbot';

```

For Vue, refer to: [Vue Demo](./demo/vue)

For React, refer to: [React Demo](./demo/react)

To enable stream mode, you need to add the `stream` attribute to the `chat-bot` tag.

```html

```

### For pure HTML use

```html

    

        

        ChatBot

        

        

    

    

        

    

```

## Develop

```bash

# 0. Clone project

git clone https://github.com/yugasun/chatbot

# 1. Install dependencies

pnpm install

# 2. Start develop server

pnpm dev

# 3. Build

pnpm build

```

## License

[MIT @yugasun](./LICENSE)