readme udpate
This commit is contained in:
Mckay Wrigley
parent
48f3f557e1
commit
f05390c97d
78
README.md
78
README.md
|
|
@ -1 +1,77 @@
|
||||||
# Chatbot UI
|
# Chatbot UI Pro
|
||||||
|
|
||||||
|
An advanced chatbot kit for OpenAI's chat model using Next.js, TypeScript, and Tailwind CSS.
|
||||||
|
|
||||||
|
It aims to mimic ChatGPT's interface and functionality.
|
||||||
|
|
||||||
|
All conversations are stored locally on your device.
|
||||||
|
|
||||||
|
See a [demo]().
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Updates
|
||||||
|
|
||||||
|
Chatbot UI Pro will be updated over time.
|
||||||
|
|
||||||
|
Expect frequent improvements.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
Chatbot UI Pro provides a ChatGPT-like interface that you can use to start building your own chatbot apps powered by OpenAI.
|
||||||
|
|
||||||
|
It has everything you need to hit the ground running.
|
||||||
|
|
||||||
|
Modify the chat interface in `components/Chat`.
|
||||||
|
|
||||||
|
Modify the sidebar interface in `components/Sidebar`.
|
||||||
|
|
||||||
|
Tweak the system prompt in `utils/index.ts`.
|
||||||
|
|
||||||
|
## Deploy
|
||||||
|
|
||||||
|
**Vercel**
|
||||||
|
|
||||||
|
Host your own live version of Chatbot UI Pro with Vercel.
|
||||||
|
|
||||||
|
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmckaywrigley%2Fchatbot-ui-pro&env=OPENAI_API_KEY&envDescription=Your%20OpenAI%20API%20Key.%20Chat%20will%20not%20work%20if%20you%20don't%20provide%20it.)
|
||||||
|
|
||||||
|
**Replit**
|
||||||
|
|
||||||
|
Fork Chatbot UI Pro on Replit [here](https://replit.com/@MckayWrigley/chatbot-ui-pro?v=1).
|
||||||
|
|
||||||
|
## Running Locally
|
||||||
|
|
||||||
|
**1. Clone Repo**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/mckaywrigley/chatbot-ui-pro.git
|
||||||
|
```
|
||||||
|
|
||||||
|
**2. Install Dependencies**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm i
|
||||||
|
```
|
||||||
|
|
||||||
|
**3. Provide OpenAI API Key**
|
||||||
|
|
||||||
|
Create a .env.local file in the root of the repo with your OpenAI API Key:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
OPENAI_API_KEY=<YOUR_KEY>
|
||||||
|
```
|
||||||
|
|
||||||
|
**4. Run App**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
**5. Use It**
|
||||||
|
|
||||||
|
You should be able to start chatting.
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
If you have any questions, feel free to reach out to me on [Twitter](https://twitter.com/mckaywrigley).
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,9 @@
|
||||||
import { Message, OpenAIModel, OpenAIModelNames } from "@/types";
|
import { Message, OpenAIModel, OpenAIModelNames } from "@/types";
|
||||||
import { FC, useEffect, useRef } from "react";
|
import { FC, useEffect, useRef } from "react";
|
||||||
import { ModelSelect } from "../ModelSelect";
|
|
||||||
import { ChatInput } from "./ChatInput";
|
import { ChatInput } from "./ChatInput";
|
||||||
import { ChatLoader } from "./ChatLoader";
|
import { ChatLoader } from "./ChatLoader";
|
||||||
import { ChatMessage } from "./ChatMessage";
|
import { ChatMessage } from "./ChatMessage";
|
||||||
|
import { ModelSelect } from "./ModelSelect";
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
model: OpenAIModel;
|
model: OpenAIModel;
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
import { Conversation } from "@/types";
|
import { Conversation } from "@/types";
|
||||||
import { IconPlus } from "@tabler/icons-react";
|
import { IconPlus } from "@tabler/icons-react";
|
||||||
import { FC } from "react";
|
import { FC } from "react";
|
||||||
import { Conversations } from "../Conversations";
|
import { Conversations } from "./Conversations";
|
||||||
import { SidebarSettings } from "./SidebarSettings";
|
import { SidebarSettings } from "./SidebarSettings";
|
||||||
|
|
||||||
interface Props {
|
interface Props {
|
||||||
|
|
|
||||||
|
|
@ -175,10 +175,10 @@ export default function Home() {
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<Head>
|
<Head>
|
||||||
<title>Chatbot UI</title>
|
<title>Chatbot UI Pro</title>
|
||||||
<meta
|
<meta
|
||||||
name="description"
|
name="description"
|
||||||
content="A simple chatbot starter kit for OpenAI's chat model using Next.js, TypeScript, and Tailwind CSS."
|
content="An advanced chatbot starter kit for OpenAI's chat model using Next.js, TypeScript, and Tailwind CSS."
|
||||||
/>
|
/>
|
||||||
<meta
|
<meta
|
||||||
name="viewport"
|
name="viewport"
|
||||||
|
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 474 KiB After Width: | Height: | Size: 368 KiB |
Loading…
Reference in New Issue