https://github.com/brandtam/sa-bot

https://github.com/brandtam/sa-bot

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/brandtam/sa-bot
• Owner: brandtam
• License: mit
• Created: 2024-03-22T03:59:48.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-03-22T04:03:02.000Z (11 months ago)
• Last Synced: 2024-05-01T19:40:35.165Z (10 months ago)
• Language: Svelte
• Homepage: https://sa-bot-seven.vercel.app
• Size: 979 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# SA Bot

A slack style chatbot that uses OpenAI's GPT-4 API to generate responses.

## What it does

The app defines different "bots" to chat with. Each bot has it's own personality and style of responses. The app uses OpenAI's GPT-4 API to generate responses for the bot.

---

## Install the project

- Clone the project onto your local machine

```bash

git clone https://github.com/brandtam/sa-bot.git

```

- Install the packages with your favorite package manager (pnpm)

```bash

pnpm install

```

## Setup the OpenAI API

- Create an account on [OpenAI](https://platform.openai.com/)

- Create an API key

- Create a `.env` file in the root of the project

- Add your API key to the `.env` file as follows:

```bash

OPENAI_API_KEY=your_api_key_that_you_copied_from_openai

```

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

- Start the server locally

```bash

pnpm dev

```

## Building

To create a production version of your app:

```bash

pnpm run build

```

## Deploying to Production

Since this specific app uses Vercel Edge Functions you will need to deploy to [Vercel](https://www.vercel.com).

- Copy the OpenAi API key to the projects environment variables on Vercel.

## License

[MIT](LICENSE.md)