burntsushi-erd-node's Introduction

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

burntsushi-erd-node's People

Contributors

Watchers

burntsushi-erd-node's Issues

Add binaries build script for Windows

Maybe install from package manager kinda choco or scoop, if it installed.
Need install:

graphviz
haskell-stack

Haskell Stack installed gcc and other build tools.

Add binaries build script for OSx

Edit binaries build script for Unix

remove coping binary to /usr/bin
remove check installing erd in system

Copy builded binaries to node_modules/.bin directory

After install package and build tools and build binaries, copy binaries to .bin directory.
Maybe replace binaries to another package to possibility install binaries globaly.