{"id":13427830,"url":"https://github.com/voormedia/rails-erd","last_synced_at":"2025-05-12T15:38:47.447Z","repository":{"id":1078864,"uuid":"923028","full_name":"voormedia/rails-erd","owner":"voormedia","description":"Generate Entity-Relationship Diagrams for Rails applications","archived":false,"fork":false,"pushed_at":"2023-10-12T07:05:55.000Z","size":1299,"stargazers_count":4045,"open_issues_count":94,"forks_count":374,"subscribers_count":57,"default_branch":"master","last_synced_at":"2025-04-23T17:43:12.241Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://voormedia.github.io/rails-erd/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voormedia.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2010-09-19T18:51:11.000Z","updated_at":"2025-04-11T01:41:29.000Z","dependencies_parsed_at":"2023-07-05T21:16:21.208Z","dependency_job_id":"0a07157e-1a05-4fba-9900-e60b63ff9514","html_url":"https://github.com/voormedia/rails-erd","commit_stats":{"total_commits":418,"total_committers":77,"mean_commits":5.428571428571429,"dds":0.6411483253588517,"last_synced_commit":"52cb2ceff7e6ac79839dc617d23e462903881a29"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voormedia%2Frails-erd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voormedia%2Frails-erd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voormedia%2Frails-erd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voormedia%2Frails-erd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voormedia","download_url":"https://codeload.github.com/voormedia/rails-erd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253766855,"owners_count":21961006,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T01:00:40.971Z","updated_at":"2025-05-12T15:38:47.394Z","avatar_url":"https://github.com/voormedia.png","language":"Ruby","funding_links":[],"categories":["Plugins","Rails Plugins","Uncategorized","Ruby","others","插件","Data Visualization","Gems","ActiveRecord"],"sub_categories":["Omniauth","Rails Class Diagrams","Uncategorized","Articles"],"readme":"Rails ERD - Generate Entity-Relationship Diagrams for Rails applications\n========================================================================\n[![Tests](https://github.com/voormedia/rails-erd/actions/workflows/test.yml/badge.svg)](https://github.com/voormedia/rails-erd/actions/workflows/test.yml) [![Code Climate](https://codeclimate.com/github/voormedia/rails-erd/badges/gpa.svg)](https://codeclimate.com/github/voormedia/rails-erd)\n\n[Rails ERD](https://voormedia.github.io/rails-erd/) is a gem that allows you to easily generate a diagram based on your application's 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.\n\nThe 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.\n\nRails ERD was created specifically for Rails and works on versions 3.0-5.0. It uses Active Record's built-in reflection capabilities to figure out how your models are associated.\n\n\nPreview\n-------\n\nHere's an example entity-relationship diagram that was generated by Rails ERD:\n\n![Entity-Relationship Diagram](https://voormedia.github.io/rails-erd/images/entity-relationship-diagram.png)\n\nBrowse the [gallery](https://voormedia.github.io/rails-erd/gallery.html) for more example diagrams.\n\n\nRequirements\n---------------\n\n* Ruby 1.9.3+\n* ActiveRecord 3.x - 5.0.x\n\nGetting started\n---------------\n\nSee the [installation instructions](https://voormedia.github.io/rails-erd/install.html) for a complete description of how to install Rails ERD. Here's a summary:\n\n* Install Graphviz 2.22+ ([how?](https://voormedia.github.io/rails-erd/install.html)). On macOS with Homebrew run `brew install graphviz`.\n\n* on linux - `sudo apt-get install graphviz`\n\n* Add \u003ctt\u003egem 'rails-erd', group: :development\u003c/tt\u003e to your application's Gemfile\n\n* Run \u003ctt\u003ebundle exec erd\u003c/tt\u003e\n\n### Configuration\n\n\nRails ERD has the ability to be configured via the command line or through the use of a YAML file with configuration options set. It will look for this file first at `~/.erdconfig` and then `./.erdconfig` (which will override any settings in `~/.erdconfig`). The format of the file is as follows (shown here with the default settings used if no `.erdconfig` is found). More information on [customization options](https://voormedia.github.io/rails-erd/customise.html) can be found in Rails ERD's project documentation.\n\n```yaml\nattributes:\n  - content\n  - foreign_keys\n  - inheritance\ndisconnected: true\nfilename: erd\nfiletype: pdf\nindirect: true\ninheritance: false\nmarkup: true\nnotation: simple\norientation: horizontal\npolymorphism: false\nsort: true\nwarn: true\ntitle: sample title\nexclude: null\nonly: null\nonly_recursion_depth: null\nprepend_primary: false\ncluster: false\nsplines: spline\nfonts:\n normal: \"Arial\"\n bold: \"Arial Bold\"\n italic: \"Arial Italic\"\n```\n\nAuto generation\n---------------\n\n* Run \u003ctt\u003ebundle exec rails g erd:install\u003c/tt\u003e\n* Run \u003ctt\u003ebundle exec rails db:migrate\u003c/tt\u003e, then the diagram is generated\n\nLearn more\n----------\n\nMore information can be found on [Rails ERD's project homepage](https://voormedia.github.io/rails-erd/).\n\nIf you wish to extend or customise Rails ERD, take a look at the [API documentation](http://rubydoc.info/github/voormedia/rails-erd/frames).\n\n\nAbout Rails ERD\n---------------\n\nRails ERD was created by Rolf Timmermans (r.timmermans *at* voormedia.com)\n\nCopyright 2010-2015 Voormedia - [www.voormedia.com](http://www.voormedia.com/)\n\n\nLicense\n-------\n\nRails ERD is released under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoormedia%2Frails-erd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoormedia%2Frails-erd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoormedia%2Frails-erd/lists"}