FlowGPT is an AI-powered tool designed to generate flowcharts from natural language prompts, leveraging GPT-3.5 and Langchain. It targets developers and users who need to visualize processes or workflows quickly, offering a streamlined way to create diagrams.

How It Works

The tool utilizes Langchain to process user prompts and interact with the OpenAI API (GPT-3.5) to generate flowchart definitions. These definitions are then rendered using Mermaid, a JavaScript-based diagramming tool, allowing for dynamic and interactive visualization within a web interface.

Quick Start & Requirements

• Install: Clone the repository, rename env.template to .env.local and add your OPENAI_API_KEY, then run yarn to install dependencies.
• Run: Execute yarn dev to start the development server.
• Prerequisites: Node.js version 18 or higher, OpenAI API Key.
• Docs: https://github.com/nilooy/flowgpt

Highlighted Details

• AI-driven flowchart generation from text prompts.
• Built with Next.js, Langchain, and Mermaid.js.
• User-friendly web interface for diagram creation.

Maintenance & Community

The project is relatively new with an invitation for contributions. Updates and roadmap discussions are available via the repository.

Licensing & Compatibility

The repository does not explicitly state a license. Users should verify licensing for commercial or closed-source integration.

Limitations & Caveats

The tool relies on an external OpenAI API key, incurring potential costs. Automatic syntax error detection and saving features are listed on the roadmap, indicating they are not yet implemented.