Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/polyfact/polyfire-chat-react-vite-ts-boilerplate
Customizable chatbot template powered by Polyfact SDK. Craft a unique Assistant experience, tailored and relevant like never before.
https://github.com/polyfact/polyfire-chat-react-vite-ts-boilerplate
ai assistant chatbot claude cohere craft customizable gpt-3 gpt-4 llama openai polyfact sdk
Last synced: 3 months ago
JSON representation
Customizable chatbot template powered by Polyfact SDK. Craft a unique Assistant experience, tailored and relevant like never before.
- Host: GitHub
- URL: https://github.com/polyfact/polyfire-chat-react-vite-ts-boilerplate
- Owner: polyfact
- License: mit
- Created: 2023-07-31T14:36:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-21T11:07:42.000Z (about 1 year ago)
- Last Synced: 2024-07-15T07:18:11.613Z (6 months ago)
- Topics: ai, assistant, chatbot, claude, cohere, craft, customizable, gpt-3, gpt-4, llama, openai, polyfact, sdk
- Language: TypeScript
- Homepage:
- Size: 5.14 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🤖 polyfire-chat-react-boilerplate
Elevate your chat experience with the Polyfire SDK, seamlessly integrated into a React project and stylishly crafted using styled-components! Embrace the power and safety of TypeScript in your React development.
## 📌 Table of Contents
- [🌟 Features](#-features)
- [🔧 Prerequisites](#-prerequisites)
- [🚀 Installation](#-installation)
- [🖥 Usage](#-usage)
- [🎨 Color Picker for Development](#-color-picker-for-development)
- [💬 Using polyfire-cli](#-using-polyfire-cli)
- [🔑 Scripts](#-scripts)
- [📚 Dependencies](#-dependencies)
- [🥞 Stack](#-stack)
- [✨ Contributing](#-contributing)
- [📜 License](#-license)
## 🌟 Features
- Smooth integration with the Polyfire SDK for enhanced chat functionalities.
- Ready-to-use themes for chat, header, and footer, customizable to fit your needs.
- Developed with the versatile and powerful React framework.
## 🔧 Prerequisites
- Node.js
- npm/yarn
## 🚀 Installation
1️⃣. Clone the repository:
```bash
git clone https://github.com/polyfire-ai/polyfire-chat-react-boilerplate.git
```
2️⃣. Navigate to the project directory:
```bash
cd polyfire-chat-react-boilerplate
```
3️⃣. Install dependencies:
```bash
npm install
```
## 🖥 Usage
1️⃣. Launch the development server:
```bash
npm start
```
2️⃣. Visit `http://localhost:3000` to see your chatbot in action!
## 🎨 Color Picker for Development
In the development environment, a color picker tool is included for personalizing the chat UI's color palette. This tool enables developers to experiment with various colors in real-time. After selecting your preferred colors, click the "Copy Config Color" button to copy the configuration. Then, update the default color configuration in `src/app/page.tsx` with your new selection.
## 💬 Using polyfire-cli
Opt for the `polyfire-cli` for a streamlined setup:
1️⃣. Activate the CLI:
```bash
npx polyfire-js
```
2️⃣. Choose "chat".
3️⃣. Follow the step-by-step instructions for a hassle-free configuration.
## 🔑 Scripts
- `npm start`: Run the development server.
- `npm run build`: Get ready for production.
- `npm run preview`: Peek into the production-ready build.
## 📚 Dependencies
- Core: `react`, `react-dom`
- Chat: `@polyfire/chat`, `polyfire`
- Icons: `phosphor-react`
- Dialog: `@radix-ui/react-dialog`
- Types: `typescript`
## 🥞 Stack
- React
- TypeScript
## ✨ Contributing
Ideas? 🤔 Bugs? 🐞 Be a part of our journey! Check out [issues](https://github.com/polyfire-ai/polyfire-chat-react-boilerplate/issues) to contribute.
## 📜 License
This project adheres to the MIT License. Refer to the `LICENSE` file for more information.
---
If polyfire-chat-react-boilerplate brightens your day, don't forget to give us a ⭐ on GitHub!