RailsRouteFinder
RailsRouteFinder is a gem designed to help Rails developers visualize and analyze the routes of their application. The gem allows you to list, filter, and analyze routes based on various parameters such as path, HTTP verb, controller#action, required parameters, and namespaces.
Installation
Add the gem via RubyGems.org, or use bundler to add & install.
Inject Routes into Your Application
After installing the gem, you'll need to inject the routes provided by RailsRouteFinder into your application. To do this, add the following snippet to your config/routes.rb file:
In config/routes.rb
Add this to your routes.rb
RailsRouteFinder::Engine.routes.draw do
get 'index', to: 'routes#index', as: :index
root to: 'routes#index'
endThis will add a new route (/rails_route_finder) to your application that you can visit to visualize your application's routes.
Usage
Once installed, you can access the /rails_route_finder route to see an overview of all your application's routes. The routes will be displayed with details like:
- Path
- HTTP verb
- Controller#action
- Required parameters
- Namespace
You can filter, sort, and analyze these routes based on the provided parameters.
Development
TO DO
Contributing
TO DO
License
TO DO