Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vikyw89/slack-gpt-agent
https://github.com/vikyw89/slack-gpt-agent
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/vikyw89/slack-gpt-agent
- Owner: vikyw89
- Created: 2024-07-20T17:15:18.000Z (5 months ago)
- Default Branch: alpha
- Last Pushed: 2024-07-21T17:40:42.000Z (5 months ago)
- Last Synced: 2024-10-12T08:45:29.520Z (2 months ago)
- Language: Python
- Size: 144 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Slack Bot
## Overview
This project is a Slack bot built using the `slack-bolt` framework, `FastAPI`, `langgraph`. The bot listens for events such as mentions and messages, and responds accordingly.
## Setup
### Prerequisites
- Python 3.11 or higher
- Poetry for dependency management
### Installation
1. Clone the repository.
2. Install dependencies using Poetry:
```bash
poetry install
```
### Configuration
copy .env example and fill all .env
```bash
cp .env.example .env
```
### Running the Development Server
To run the development server, use the following command:
```bash
poetry run dev
```
This command will:
- Terminate any process using port 8000.
- Start the FastAPI server.
## Features
### Event Handling
- **App Mentions**: The bot responds with "What's up?" when mentioned.
- **Messages**: The bot currently does not respond to messages.
### API Endpoints
- `/slack/events`: Handles Slack events.
- `/slack/install`: Handles the installation flow for OAuth.
- `/slack/oauth_redirect`: Handles the OAuth redirect.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any changes.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.