Generate Entity-Relationship Diagrams for Rails applications
Pull request Compare This branch is 313 commits behind voormedia:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
lib
site
test
.gitignore
CHANGES.rdoc
Gemfile
Gemfile.lock
LICENSE
README.rdoc
Rakefile
VERSION
rails-erd.gemspec

README.rdoc

Rails ERD - Generate Entity-Relationship Diagrams for Rails applications

Rails ERD is a Rails plugin that allows you to easily generate a diagram based on your Active Record models. The diagram gives an overview of how your models are related. Having a diagram that describes your models is perfect documentation for your application.

The second goal of Rails ERD is to provide you with a tool to inspect your application's domain model. If you don't like the default output, it is very easy to use the API to build your own diagrams.

Rails ERD was created specifically for Rails 3. It uses Active Record's built-in reflection capabilities to figure out how your models are associated.

Preview

Here's an example entity-relationship diagram that was generated by Rails ERD:

Learn more

Homepage: rails-erd.rubyforge.org/

Diagram gallery: rails-erd.rubyforge.org/gallery.html

Installation instructions: rails-erd.rubyforge.org/install.html

Resources

Internal API documentation: rails-erd.rubyforge.org/doc/

Source code at Github: github.com/voormedia/rails-erd

Rubygem page: rubygems.org/gems/rails-erd

About Rails ERD

Author: Rolf Timmermans (r.timmermans at voormedia.com)

Copyright 2010 Voormedia B.V.

License

Rails ERD is released under the MIT license. See the LICENSE.

Credits

Rails ERD depends on the Ruby-Graphviz library to generate diagrams: github.com/glejeune/Ruby-Graphviz/