Giter Club home page Giter Club logo

guard-livereload's Introduction

Guard::LiveReload Build Status

LiveReload guard allows to automatically reload your browser when 'view' files are modified.

Install

Please be sure to have Guard installed before continuing.

Install the gem:

$ gem install guard-livereload

Add it to your Gemfile (inside development group):

group :development do
  gem 'guard-livereload'
end

Add guard definition to your Guardfile by running this command:

$ guard init livereload

Use rack-livereload or install LiveReload Safari/Chrome extension

Optional

To optimize communication with the LiveReload extension, install the yajl-ruby to increase JSON performance:

$ gem install yajl-ruby

Usage

Please read Guard usage doc and rack-livereload how it works readme section or LiveReload extension usage doc

Guardfile

You can adapt your 'view' files like you want. Please read Guard doc for more info about Guardfile DSL.

guard 'livereload' do
  watch(%r{app/.+\.(erb|haml)})
  watch(%r{app/helpers/.+\.rb})
  watch(%r{(public/|app/assets).+\.(css|js|html)})
  watch(%r{(app/assets/.+\.css)\.s[ac]ss}) { |m| m[1] }
  watch(%r{(app/assets/.+\.js)\.coffee}) { |m| m[1] }
  watch(%r{config/locales/.+\.yml})
end

== Options

LiveReload guard has 6 options that you can set like this:

guard 'livereload', :api_version => '1.4', :port => '35728' do
  # ...
end

Available options:

:api_version => '1.4'    # default '1.6'
:host => '127.3.3.1'     # default '0.0.0.0'
:port => '12345'         # default '35729'
:apply_js_live => false  # default true
:apply_css_live => false # default true
:grace_period => 0.5     # default 0 (seconds)

See LiveReload configuration doc for more info about those options.

Development

Pull requests are very welcome! Please try to follow these simple "rules", though:

  • Please create a topic branch for every separate change you make.
  • Make sure your patches are well tested.
  • Update the README (if applicable).
  • Please do not change the version number.

For questions please join us on our Google group or on #guard (irc.freenode.net).

Author

Thibaud Guillaume-Gentil

guard-livereload's People

Contributors

thibaudgg avatar assembler avatar rymai avatar tdreyno avatar aaronjensen avatar alexcrichton avatar fnichol avatar nv avatar sunny avatar tjmcewan avatar vderyagin avatar

Stargazers

 avatar Shayne Kang avatar

Watchers

Shayne Kang 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.