Skip to content

ErdKeeper is a gem that outputs ER diagram by setting yaml. The output of ER diagram is realized by wrapping call of rails-erd.

License

Notifications You must be signed in to change notification settings

shakemurasan/erd-keeper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ErdKeeper

ErdKeeper is a gem that outputs ER diagram by setting yaml.

The output of ER diagram is realized by wrapping call of rails-erd.

This gem generate a diagram based on your application's Active Record models.

Getting started

Add this line to your application's Gemfile:

gem 'erd-keeper'

And then execute:

$ bundle

Usage

Create configuration file (Write your application's Active Record models):

diagrams:
  tweet:
    - User
    - Micropost
  all:
    - User
    - Micropost
    - Relationship

And then execute:

$ bundle exec erd-keeper --input="config/erd-keeper.yml" --output="./"

Options

  • --input : Write the path of the configuration file.
  • --output : Write the path of the output ER diagram.

License

The gem is available as open source under the terms of the MIT License.

About

ErdKeeper is a gem that outputs ER diagram by setting yaml. The output of ER diagram is realized by wrapping call of rails-erd.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages