ACV OpenAI

A simple-to-use chatbot powered by OpenAI.

Getting Started

This application relies on having a valid and working OpenAI API key. To retrieve your key, visit the OpenAI API key generation page. Note: key generation requires you to register an account on OpenAI free of charge.

Once an API key has been generated, store its value in the OPEN_AI_API_KEY variable located in the .env file.

Afterwards, perform the steps below to get the project up and running.

Build Setup

# install dependencies
$ npm install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm run start

# generate static project
$ npm run generate

Usage

Once running, navigate to localhost:3000. To interact with the chatbot, simply write a prompt inside of the text box, and press submit. Once the OpenAI responds, a chat history will appear displaying any previously submitted prompts and responses. To clear the conversation and start from scratch, simply click the trash icon located on the right of Chat History.

OpenAI API Documentation

For further information on integrating with OpenAI, check out out their documentation.

Contributing

Please see CONTRIBUTING.md for details on how to contribute to the project.