Skip to content

Want to restart your Rails development server whilst you work? Now you can!

Notifications You must be signed in to change notification settings

nycvotes-dev/guard-rails

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Guard-rails is watching on your railses!

Gem Version Build Status Dependency Status Code Climate

Main repository

Currently, the official fork repository is at ranmocy/guard-rails. Please, come here and communicate with me.

Install

Please make sure to have Guard installed before continue.

Add Guard::Rails to your Gemfile:

group :development do
  gem 'guard-rails'
end

Add the default Guard::Rails template to your Guardfile by running:

$ guard init rails

Now I can automatically restart your Rails development server as your files changed!

Lots of fun options growing!

  • :daemon runs the server as a daemon, without any output to the terminal that ran guard (default false)
  • :debugger enable the debugger in server. Required ruby-debug gem. (default false)
  • :environment is the server environment (default development)
  • :force_run kills any process that's holding the listen port before attempting to (re)start Rails (default false)
  • :pid_file specify your pid_file (default tmp/pids/[RAILS_ENV].pid)
  • :port is the server port number (default 3000)
  • :root lets you specify the Rails root, i.e. for using guard-rails to run a dummy app within an engine (try :root => '/spec/dummy').
  • :server the webserver engine to use (try :server => :thin)
  • :start_on_start will start the server when starting Guard (default true)
  • :timeout waits when restarting the Rails server, in seconds (default 30).
  • :zeus_plan the custom plan in zeus, only works when zeus option is true (default server)
  • :zeus support zeus to boost rails init speed (default false).
  • :CLI construct the runner command as your willing! Will omit all options above except pid_file! (default rails server --pid tmp/pids/[RAILS_ENV].pid)

How-to

  • Multiple instances use pid_file option to run multiple instances with same rails_env

Contribute

The best choise to contact me is the Issues and Pull Request system on GitHub. Currently the official fork repository is at ranmocy/guard-rails.

Please, post your issue or pull request there. And I will be there as your call.

Philosophy

  • All Platforms MRI is the main test case. But will be tested under REE and JRuby.
  • Live in edge I am tested under Ruby 1.8.7, 1.9.3, 2.0.0 with newest gems. Will be rewrited to fit Ruby 2.0.0 when I am released as version 1.0.0.
  • Semantic Version

About

Want to restart your Rails development server whilst you work? Now you can!

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%