Skip to content
This repository has been archived by the owner on Aug 6, 2021. It is now read-only.

Latest commit

 

History

History
82 lines (50 loc) · 2.38 KB

README.md

File metadata and controls

82 lines (50 loc) · 2.38 KB

image_squidhome@2x.png

sails-generate-gruntfile

A gruntfile generator for use with the Sails command-line interface.

Installation

Certain generators are installed by default in Sails, but they can be overridden. Check the Sails docs for information on installing generator overrides / custom generators.

Production Usage

On the command line
$ sails generate gruntfile
In a node script
var path = require('path');
var sailsgen = require('sails-generate');
var scope = {
	rootPath: path.resolve(__dirname)
};
sailsgen(require('sails-generate-gruntfile'), scope, function (err) {
	if (err) throw err;

	// It worked.
});

Development

To get started quickly and see this generator in action, run the bin/index.js script:

$ git clone YOUR_FORK_OF_THIS_REPO sails-generate-gruntfile-fork
$ cd sails-generate-gruntfile-fork
$ npm install
$ node ./bin

bin/index.js is a simple script, bundled only for convenience, that runs the generator with hard-coded scope variables. Please feel free to modify that file however you like! Also see CONTRIBUTING.md for more information on overriding/enhancing generators.

Questions?

See FAQ.md.

More Resources

License

MIT © 2014 balderdashy & [contributors] Mike McNeil, Balderdash & contributors

Sails is free and open-source under the MIT License.