https://github.com/koedame/rails-mermaid_erd
Generate Mermaid ERD from your Ruby on Rails application.
https://github.com/koedame/rails-mermaid_erd
diagram erd gem mermaid ruby-on-rails
Last synced: about 1 year ago
JSON representation
Generate Mermaid ERD from your Ruby on Rails application.
- Host: GitHub
- URL: https://github.com/koedame/rails-mermaid_erd
- Owner: koedame
- License: mit
- Created: 2022-10-05T01:19:39.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-31T05:33:31.000Z (about 1 year ago)
- Last Synced: 2025-03-31T21:43:31.652Z (about 1 year ago)
- Topics: diagram, erd, gem, mermaid, ruby-on-rails
- Language: HTML
- Homepage:
- Size: 774 KB
- Stars: 150
- Watchers: 0
- Forks: 24
- Open Issues: 16
-
Metadata Files:
- Readme: README.ja.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rails - rails-mermaid_erd - A gem to interactively generate entity-relationship diagram in image or Markdown format. [:red_circle:](https://rubygems.org/gems/rails-mermaid_erd) (Gems / Articles)
README
[English](./README.md) | [日本語](./README.ja.md)
# Rails Mermaid ERD
[](https://github.com/koedame/rails-mermaid_erd/actions/workflows/run-test.yml)
[](https://rubygems.org/gems/rails-mermaid_erd)
Ruby on Railsアプリケーションから [Mermaid ERD](https://mermaid-js.github.io/mermaid/#/entityRelationshipDiagram) を生成します。
[
](./docs/screen_shot.png)
[デモページ](https://koedame.github.io/rails-mermaid_erd/example.html)
ERDは自由自在に生成できます。
生成されたERDはMarkdown形式でコピーできるため、GitHubなどで簡単に共有できます。
画像として保存することもできるので、Mermaidが使えない環境でも使えます。
エディターはシングルHTMLファイルであるため、エディター本体を共有することも可能です。
## インストール手順
導入したいRailsアプリケーションのGemfileに以下の行を追加してください。
```ruby
gem "rails-mermaid_erd", group: :development, require: false
```
次に、以下のコマンドを実行してGemをインストールします。
```bash
$ bundle install
```
次に、Rakefileに以下の行を追加してください。
```ruby
begin
require "rails-mermaid_erd"
rescue LoadError
# Do nothing.
end
```
## 使い方
Rakeタスク `mermaid_erd` を実行すると `/mermaid_erd/index.html` が生成されます。
```bash
$ bundle exec rails mermaid_erd
# or
$ bundle exec rake mermaid_erd
```
生成された `/mermaid_erd/index.html` をお使いのブラウザで開くだけです。
このファイルをGit管理から除外したい場合は `.gitignore` に以下の行を追加してください。
```.gitignore
mermaid_erd
```
`/mermaid_erd/index.html` はシングルHTMLファイルです。
このファイルを共有すれば、Ruby on Rails環境が無くても使用できます。サーバーにアップロードすれば、同じURLを共有することもできます。
CIと連携して生成から共有までを自動化するのはとても有効な手段です。
## 設定
`./config/mermaid_erd.yml` を設置することで設定を変更できます。
設定例は [./docs/example.yml](./docs/example.yml) を参照してください。
設定項目は次のとおりです。
| キー | 説明 | 初期値 |
| --- | --- | --- |
| `result_path` | 生成されるファイルのパス。 | `mermaid_erd/index.html` |
## ライセンス
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).