vue-flow/README.md

# Vue Flow
[![vue flow](./src/assets/vue-flow.gif)](https://reactflow.dev/)
![top-language](https://img.shields.io/github/languages/top/bcakmakoglu/vue-flow)
[![dependencies Status](https://status.david-dm.org/gh/bcakmakoglu/vue-flow.svg)](https://david-dm.org/bcakmakoglu/vue-flow)
[![devDependencies Status](https://status.david-dm.org/gh/bcakmakoglu/vue-flow.svg?type=dev)](https://david-dm.org/bcakmakoglu/vue-flow?type=dev)
![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/bcakmakoglu/vue-flow)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/bcakmakoglu/vue-flow)
![GitHub last commit](https://img.shields.io/github/last-commit/bcakmakoglu/vue-flow)

This repo is still a big construction site with nothing really finished.
You can check the examples to see what's working and what's not.
Please visit [React Flow](https://reactflow.dev/) and support them if you like the idea. 
They did most of the heavy lifting by writing the library in the first place.
All I did is bring it to Vue.

### Motivation
Seeing as many libraries exist in the React ecosystem and Vue sadly does not get the same
love and attention, I decided to port the React Flow library to Vue.js.

## Usage
Check the React Flow docs for usage. It's really the same.

### Vue 3
```bash
# install vue flow
$ pnpm add @braks/vue-flow

# or
$ npm i --save @braks/vue-flow
```

### Vue 2
Vue Flow doesn't work with Vue 2, sorry.

## 🧪 Development
```bash
# start (dev)
$ pnpm dev

# build app
$ pnpm build

# serve app from build
$ pnpm serve

# build dist
$ pnpm build:dist
```