firstdraft / dev_toolbar

MIT License
1 stars 0 forks source link

DevToolbar

First Draft DevToolbar for appdev-projects beginner ergonomics in Rails applications.

Installation

Add this line to your application's Gemfile:

group :development do
  gem "dev_toolbar"
end

Then execute:

bundle install

Then, add a configuration file with the names and routes you want links for:

# config/initializers/dev_toolbar.rb
DevToolbar.configure do |config|
  config.links = [
    { name: "Routes", path: "/rails/info/routes" },
    { name: "Database", path: "/rails/db" }, # rails_db gem must be installed
    { name: "Data Model", path: "/erd.png" }, # erd.png must be in public/ folder
    # etc.
  ]
end

These routes will now appear on every page in your app while in development.

Updating the gem

  1. Pull request and make changes
  2. Test locally
  3. Bump lib/dev_toolbar/version.rb
  4. gem build dev_toolbar.gemspec
  5. gem push dev_toolbar-X.X.X.gem

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/firstdraft/dev_toolbar.

License

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