Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jtlicardo/bpmn-assistant
LLM-powered assistant for creating, editing, and interpreting business process diagrams
https://github.com/jtlicardo/bpmn-assistant
anthropic bpmn claude gemini llm openai
Last synced: about 2 months ago
JSON representation
LLM-powered assistant for creating, editing, and interpreting business process diagrams
- Host: GitHub
- URL: https://github.com/jtlicardo/bpmn-assistant
- Owner: jtlicardo
- License: mit
- Created: 2023-11-11T19:54:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-12T19:55:39.000Z (5 months ago)
- Last Synced: 2024-08-13T17:23:56.972Z (5 months ago)
- Topics: anthropic, bpmn, claude, gemini, llm, openai
- Language: Python
- Homepage:
- Size: 326 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BPMN Assistant
BPMN Assistant is an application that uses Large Language Models (LLMs) to assist with creating, editing, and
interpreting Business Process Model and Notation (BPMN) diagrams.
## Quickstart
1. Clone the repository
```
git clone https://github.com/jtlicardo/bpmn-assistant.git
```
```
cd bpmn-assistant
```
2. Set up your environment variables
Linux, macOS
```
cd src/bpmn_assistant
```
```
cp .env.example .env
```
Windows
```
cd src\bpmn_assistant
```
```
copy .env.example .env
```
3. Open the `.env` file and replace the placeholder values with your actual API keys.
4. Build and run the application
```
docker-compose up --build
```
5. Open your browser and go to `http://localhost:8080`
## Prerequisites
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)
- At least one of the following API keys:
- [OpenAI API key](https://platform.openai.com/docs/quickstart)
- [Anthropic API key](https://console.anthropic.com/)
- [Google AI Studio (Gemini) API key](https://aistudio.google.com/app/apikey)
Note: You can use any combination of the API keys above, but at least one is required to use the app.
## Supported models
### OpenAI
* GPT-4o mini
* GPT-4o
### Anthropic
* Claude 3 Haiku
* Claude 3.5 Sonnet
### Google
* Gemini 1.5 Flash
* Gemini 1.5 Pro
## Screenshots
## Core features
1. Diagram creation - Generates BPMN diagrams based on text descriptions.
2. Diagram editing - Modifies BPMN diagrams based on user input.
3. Diagram interpretation - Provides text descriptions of BPMN diagrams.
4. Drag-and-drop functionality - Users can drag and drop BPMN files (containing only supported elements) into the
editor, then ask the LLM to edit or explain the process.
## Supported elements
The application currently supports a subset of BPMN elements:
* Task
* User task
* Service task
* Exclusive gateway
* Parallel gateway
* Start event
* End event
## Limitations
* The AI assistant does not "see" manual edits made to the diagram. It always responds based on its last generated
version. Keep this in mind when interacting with the assistant after making manual changes.
* Pools and lanes are not and will not be supported.
## Future improvements
* Expanded BPMN element support
* Implementing LLM awareness of manual edits to the diagram
## Contact
If you have any questions or feedback, please open an issue on this GitHub repository.