Files
next-ai-draw-io/README.md

119 lines
3.7 KiB
Markdown
Raw Normal View History

# Next AI Draw.io
2025-03-23 15:24:49 +00:00
A next.js web application that integrates AI capabilities with draw.io diagrams. This app allows you to create, modify, and enhance diagrams through natural language commands and AI-assisted visualization.
2025-03-23 15:28:05 +00:00
Demo site: [https://next-ai-draw-io.vercel.app/](https://next-ai-draw-io.vercel.app/)
## Features
2025-03-23 15:24:49 +00:00
- **LLM-Powered Diagram Creation**: Leverage Large Language Models to create and manipulate draw.io diagrams directly through natural language commands
- **Image-Based Diagram Replication**: Upload existing diagrams or images and have the AI replicate and enhance them automatically
- **Diagram History**: Comprehensive version control that tracks all changes, allowing you to view and restore previous versions of your diagrams before the AI editing.
- **Interactive Chat Interface**: Communicate with AI to refine your diagrams in real-time
- **Smart Editing**: Modify existing diagrams using simple text prompts
2025-03-23 15:24:49 +00:00
## How It Works
The application uses the following technologies:
2025-03-23 15:24:49 +00:00
- **Next.js**: For the frontend framework and routing
- **@ai-sdk/react**: For the chat interface and AI interactions
- **draw.io XML**: For diagram representation and manipulation
2025-03-23 15:24:49 +00:00
Diagrams are represented as XML that can be rendered in draw.io. The AI processes your commands and generates or modifies this XML accordingly.
## Getting Started
### Installation
1. Clone the repository:
```bash
2025-03-23 15:24:49 +00:00
git clone https://github.com/DayuanJiang/next-ai-draw-io
cd next-ai-draw-io
```
2. Install dependencies:
```bash
npm install
# or
yarn install
```
3. Create a `.env.local` file in the root directory with the following variables:
```
OPENAI_API_KEY=your_openai_api_key_here
# Add any other required environment variables
```
4. Run the development server:
```bash
npm run dev
```
5. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application.
## Usage
### Creating a New Diagram
Use the chat interface to describe the diagram you want to create:
```
Create a flowchart showing the user authentication process with login, validation, and dashboard access steps.
```
### Modifying an Existing Diagram
With an existing diagram open, use natural language to make changes:
```
Add a decision node after the validation step that redirects failed attempts to a retry page.
```
### Using Image References
Upload an image as a reference by clicking the attachment button in the chat interface. Then ask the AI to use it as inspiration:
```
Create a similar flowchart to this image but add two more steps at the end.
```
## Project Structure
```
app/ # Next.js application routes and pages
extract_xml.ts # Utilities for XML processing
components/ # React components
chat-input.tsx # User input component for AI interaction
chatPanel.tsx # Chat interface with diagram control
ui/ # UI components (buttons, cards, etc.)
lib/ # Utility functions and helpers
utils.ts # General utilities including XML conversion
public/ # Static assets including example images
```
## License
2025-03-23 15:24:49 +00:00
This project is licensed under the MIT License.
## Support & Contact
For support or inquiries, please open an issue on the GitHub repository or contact the maintainer at:
2025-03-23 15:24:49 +00:00
- Email: me[at]jiang.jp
## Deployment
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new) from the creators of Next.js.
Check out the [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
2025-03-23 15:24:49 +00:00
Or you can deploy by this button.
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FDayuanJiang%2Fnext-ai-draw-io)
2025-03-23 15:24:49 +00:00
---