https://github.com/joshxfi/chatbot-umamin
GPT-3.5 Chatbot with Umamin UI
https://github.com/joshxfi/chatbot-umamin
chat-gpt gpt-3-5-turbo
Last synced: 29 days ago
JSON representation
GPT-3.5 Chatbot with Umamin UI
- Host: GitHub
- URL: https://github.com/joshxfi/chatbot-umamin
- Owner: joshxfi
- License: mit
- Created: 2023-04-02T06:31:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-18T12:31:21.000Z (about 2 years ago)
- Last Synced: 2025-03-29T23:41:16.261Z (about 2 months ago)
- Topics: chat-gpt, gpt-3-5-turbo
- Language: TypeScript
- Homepage:
- Size: 81.1 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About
This project is a web-based chatbot that uses the `gpt-3.5-turbo` model to generate natural language responses to user inputs. The functionality of this chatbot is similar to that of ChatGPT, but with a custom user interface based on [Umamin](https://umamin.link). This project is created for learning purposes to explore the capabilities of advanced language models.
## Preview
## Getting Started
Clone this repository and navigate to the project directory:
```sh
$ git clone --depth=1 https://github.com/joshxfi/chatbot-umamin.git
$ cd chatbot-umamin
```
To use this repository, you'll need to obtain an OpenAI API key, which you can get [here](https://platform.openai.com/account/api-keys). Once you have your API key, create a `.env` file in the root directory of the repository and add the following line:
```env
OPENAI_API_KEY=your_api_key
```
To install the dependencies and start the chatbot, run the following commands in a terminal:
```sh
$ pnpm i
$ cd client && pnpm i
$ cd ..
$ pnpm start
```
This will start a GraphQL server on `http://locahost:4000`. You can access the chatbot at `http://localhost:5173`.
## Contributing
If you find a bug or want to suggest a new feature, feel free to create an issue or submit a pull request.
## Customization
If you want to customize the UI, you can modify the source code in the `client` directory.
To change the model of the chatbot or add new functionality, you can modify the code in the `schema` directory. See [API Reference](https://platform.openai.com/docs/api-reference/introduction) for the different models you can use.
## Tech Stack
This project is built using the following technologies:
- React (Vite)
- TypeScript
- Tailwind CSS
- Apollo
- GraphQL (TypeGraphQL)
- GPT-3.5 (OpenAI)
## License
This repository is licensed under the MIT License. See the [LICENSE](https://github.com/joshxfi/chat-umamin/blob/main/LICENSE) file for more information.