Project Introduction: chatgpt-vue
chatgpt-vue is an elegant and straightforward web-based chat application leveraging the powerful capabilities of OpenAI's gpt-3.5-turbo
model. Built with modern web technologies including Vue3, Typescript, and Tailwind CSS, this project allows users to experience seamless chatting with support for continuous conversations.
Project Overview
The chatgpt-vue project aims to deliver a clean and effective user experience by harnessing the power of artificial intelligence for conversational purposes. Vue3 and Typescript ensure a robust framework, making the application both efficient and developer-friendly. Tailwind CSS enhances the visual appeal, providing a sleek and responsive design.
How to Get Started
Getting started with chatgpt-vue is straightforward and user-friendly. Here are the essential steps to set up and run the project:
-
Prerequisite: Ensure Node.js is installed on your system. If it's not yet installed, download it from here.
-
API Key Requirement: To use the chat function, an OpenAI API Key is necessary. Users who haven't obtained an API Key can generate one by visiting the OpenAI API Key generation page.
-
Project Setup: Once the API Key is ready, navigate to the root directory of the project and execute the following commands:
npm i npm run dev
Alternatively, you can use Yarn:
yarn yarn dev
-
Running the Project: Upon successful setup, you should see a message similar to:
VITE v3.2.5 ready in 294 ms ➜ Local: http://localhost:5173/ ➜ Network: use --host to expose
Simply hold down
Ctrl
orcommand
and click the Local link to open the application in your web browser. Input your API Key into the input field at the bottom of the page and click save to start using the chat application. If you need to update your API Key later, click 'Settings' in the top right corner to re-enter and save it. -
Local Bundling: For those interested in packaging the application for local use, refer to the electron packaging guide.
Additional Information
The chatgpt-vue project does not employ any proxy, meaning it sends API requests directly from the frontend. Connectivity will depend on your current network environment. For a server-side API request alternative, you might want to explore another project, chatgpt-nuxt, with an online demo.
License
chatgpt-vue is open-source, licensed under the MIT License, allowing for flexible use and integration into other projects.
This comprehensive guide to chatgpt-vue should assist you in efficiently setting up and utilizing the project. Should you have further inquiries or require assistance, feel free to reach out in the comment section. Thank you and enjoy exploring the capabilities of chatgpt-vue!