Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 2.9 KB

README.md

File metadata and controls

82 lines (52 loc) · 2.9 KB
Raw

image_squidhome@2x.png

sails-generate-frontend-angular

A frontend AngularJS generator for use with the Sails command-line interface. This generator creates client side assets and files with grunt configurations and tasks that manage the front end assets for a sails project. To see more infomation about how it works look here.

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.

$ npm install -g sails-generate-frontend-angular

Update your .sailsrc file

If you want to use this when creating new sails projects, you will need to modify your .sailsrc file in your home directory, or the parent directory of where you are creating projects.

{
    "generators" : {
        "modules" : {
            "frontend" : "sails-generate-frontend-angular"
        }
    }
}

After this change, when you sails new <project> it will use sails-generate-frontend-angular by default.

Production Usage

On the command line
$ sails new myApp

Roadmap

  • Fix grunt tasks for production
  • Optional angular-classy support
  • Optional Coffeescript support

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-frontend-angular-fork
$ cd sails-generate-frontend-angular-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.