A gulp compilation helper for Rails
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
.gitignore
MIT-LICENCE
README.md
gulp_rails.gemspec

README.md

Gulp + Rails

If you've decided to shun the default Rails Asset Pipeline and use gulp, you may be irritated that you need to run gulp in the background whenever you're developing your Rails application in order to ensure assets are compiled when you make requests.

Image

This gem will ensure that your gulp command is executed each time a request is made and thus removing the requirement to run it elsewhere.

Directory Structure

It's recommended that you place all your gulp source files and configuration in a directory named frontend. In here, you should have your Gulpfile.js, packages.json and all other source assets.

Your compiled files should be exported to public/stylesheets and public/javascripts.

Gulpfile Optimisation

As we are running gulp on each request, it's important to optimise your Gulpfile to ensure your gulp command runs as quickly as possible. The gulp-newer plugin is useful and ensures that compilation only takes place if needed.

Installation

To get started, just add this gem to your Gemfile.

gem 'gulp_rails', '~> 1.0'

If you have followed the guidance above regarding directory structure, you don't need to do anything else. Just restart your server and you should see that your assets are compiled automatically.

Image

Configuration

If you need to configure your library, you can do use the following configuration

# Whether or not compilation should take place
GulpRails.options[:enabled]   = true
# The command to run
GulpRails.options[:command]   = 'gulp'
# The directory in which your command should be executed
GulpRails.options[:directory] = Rails.root.join('frontend')