RungerRailsModelExplorer

Explore your Rails models.

Installation

Add to your Gemfile:

gem 'runger_rails_model_explorer'

and then run bundle install.

Usage

Add a Rails controller to your application that looks something like this:

# app/controllers/model_graph_controller.rb
class ModelGraphController < ApplicationController
  def index
    bootstrap(model_metadata: RungerRailsModelExplorer.model_metadata)
  end
end

Add a view that looks something like this:

-# app/views/model_graph/index.html.haml
- content_for(:page_assets) do
  = ts_tag('model_graph')

Add a route that looks something like this:

# config/routes.rb
get 'models', to: 'model_graph#index'

NOTE: If this is a private app, then you will probably want to secure that route somehow, e.g. within a Devise authenticate :admin_user do ... end block.

Then, follow setup instructions for the @davidrunger/vue-model-explorer NPM package.