Giter Club home page Giter Club logo

sextant's Introduction

Sextant Build Status

Helps you find your routes on a long Journey on Rails, in Rails apps 3.2+.

Logo

What

Show routes in your Rails app while working in development. Visit http://localhost:3000/rails/routes and you'll see an output similar to rake routes

Sextant Gem

The Future

The core functionality of Sextant is now merged into Rails 4.0 under rails/info/routes. If you want this functionality in earlier rails use Sextant. I would like to improve that functionality and this gem is a good place to experiment. If you have ideas on functionality you would like, check the issues to make sure it hasn't been suggested before, and then create one, or send me a message @schneems

Why?

Running rake routes is slow and painful, mostly due to the time to initialize rails. When you're working in development you likely have your rails server booted, you can save this time by rendering the routes in a web request. You can only develop as quick as your tools will allow, so speeding up your tools speeds your development. Sextant allows you to quickly see your routes.

Install

Add this to the development group in your Gemfile

group :development do
  gem 'sextant'
end

Then run bundle install and you're ready to start

Optional for users of catch-all routes

If (and only if) you have catch all routes like match '*not_found' => 'errors#handle404' in your app already, you can add sextant to your routes (config/routes.rb) before the catch-all routes like this.

mount_sextant if Rails.env.development?
match '*not_found' => 'errors#handle404'

Use

Visit /rails/routes in your app and you'll see your routes. It's that simple.

About

If you have a question file an issue or find me on the Twitters @schneems.

This project rocks and uses MIT-LICENSE.

sextant's People

Contributors

schneems avatar menkel avatar ddidier avatar davidcollom avatar vfrride avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.