Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 1.14 KB

README.md

File metadata and controls

50 lines (36 loc) · 1.14 KB
Raw

BurntSushiErdNode

It is BurntSushi/erd Node.js wrapper

Info

Only UNIX supported!

After package install executed instal.sh. Sudo required.
This script will install system dependecies graphviz, stack and build BurntSushi/erd.
First build be long (10-15 minutes).
Also script copy executable to /usr/bin.

Guide

Install:

npm install -S -e burntsushierdnode 

yarn add -E burntsushierdnode

Options

Name Description Default
input Path to .er file
output Path to output file
bin Path to binary file ../bin/erd or ../bin/erd.exe

Usage

Also you can find example here

const { generate } = require('../src/index');

generate({
    input: './erd.er',
    output: './erd.svg'
});

TODO

  • Typings
  • Install and build binaries platform dependent
    • Windows
    • UNIX
    • OSx
  • Replace binary to node_modules/.bin