Giter Club home page Giter Club logo

mike-llm-slack-plugin's Introduction


Mike - Your Project Management Assistant 🧠

An awesome LLM plugin for Slack
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This project is a Project management assistant, using Pathways LLM App to assess a Trello board's data in real time to answer questions and assist in task management. Look at a few features we have incorporated now : Mike Slack App Demo

(back to top)

Built With

This project has been built in the context of Pathway's LLM Bootcamp. Big kudo's to them for their amazing course ! Here are all the tools I used :

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

In order to get the project up and running, you need to have a Trello Board, a Slack channel and an OpenAI API key. Follow the steps to :

Installation

With Docker

  1. Clone the repo
    git clone https://github.com/leabuende/mike-llm-slack-plugin.git
  2. Rename the Dockerfile.example into Dockerfile, and configure environment variables
  3. Build Docker images
    docker-compose build
  4. Start the Docker containers
    docker-compose up

Without Docker

Start LLMAppService
  1. Clone the repo

    git clone https://github.com/leabuende/mike-llm-slack-plugin.git
  2. Copy and fill the .env file with the keys that you recovered

  3. Install packages

    pip install requirements.txt
  4. Start the service

    python3 main.py
Start SlackBotService
  1. Copy and fill the .env file with the keys that you recovered (set API_URL as the URL of LLMAppService)

  2. Install packages

    pip install requirements.txt
  3. Start the service

    python3 main.py
Start Ngrok
  1. Start tunnel to connect to Slack
    ngrok http 3000

Then, follow the steps in this article starting at 3. Create a new Slack app using your ngrok address to setup your app for your Slack channel.

(back to top)

Usage

This project can be used for you to monitor your Trello board for your team, help them asses their progress and find new tasks to work on that fit with their role/set of skills.

(back to top)

Roadmap

  • Add cronjob to fetch trello cards regularly
  • Add open QA for users
  • Notify Slack channel when a new Sprint has been completed
  • Generate performance report as pdf file
  • Add a document repository to add complementary info on project roadmap and technical specifications

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

Léa Buendé - [email protected]

Project Link: Mike LLM Slack Plugin

(back to top)

mike-llm-slack-plugin's People

Contributors

leabuende avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.