README.md

Slack AI Bot

OpenAI-enabled Slack chat bot for demo purposes.

Table of Contents

• Features
• Prerequisites
• Steps
• Usage
• Configuration
• License

Features

• Integrates with OpenAI to provide intelligent responses within Slack.
• Configurable and extendable.
• Easy to deploy using Docker Compose.
• Responds to bot mentions in a thread
• Tracks each thread separately

Prerequisites

• Go (version 1.16 or higher)
• Docker
• Docker Compose
• github.com/cosmtrek/air live reloading go development tool
• Slack workspace and app. You can use slack-app-example.yaml as your slack app definition.

Steps

1. Clone the repository:

   git clone https://github.com/yourusername/slack-ai-bot.git
   cd slack-ai-bot

2. Install a slack app by following slack documentation.

3. Generate config.toml, you can take config.toml.example as refference.

4. Start the app by running air

Usage

Once the bot is running, you can interact with it within your Slack workspace. Mention the bot in any channel or send it a direct message to receive responses powered by OpenAI.

Configuration

The bot can be configured using environment variables or configuration files. The main configuration file is config.go located in the internal/config directory.

License

This project is licensed under the MIT License - see the LICENSE file for details.