/generator-onsenui-ngcordova

A yeoman Generator for scaffolding Onsen UI / ngCordova App

Primary LanguageJavaScript

generator-onsenui-ngcordova

A Yeoman Generator to Scaffold an OnsenUI (v.1.3.4) ngCordova app Based on a Fork of arvindr21's project generator-onsenui-phonegap and adapted to add ngCordova.

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

$ npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-onsenui-ngcordova from npm, run:

$ npm install -g generator-onsenui-ngcordova

Finally, initiate the generator:

$ yo onsenui-ngcordova

You can select and install all cordova plugins supported by ngCordova !

All templates use OnsenUI v1.3.4 (Jul 1, 2015) You can pick from one of the 5 available templates

  • Minimum
  • Sliding Menu
  • Tab bar
  • Master-Detail
  • Split View

Once you select a template, Yeoman will scaffold an onsenui-ngcordova app for you.

Run the App

To run the Onsenui ngCordova app in your browser, execute

$ grunt

This will start a server at port 1881. Navigate to http://localhost:1881 to see the app running.

Note: When you open the browser, you will find cordova.js as a 404 resource. This will be resolved, when you issue a PhoneGap build.

Now you can use grunt-cordova-ng tasks to manage your cordova project. You can also edit your build task.

$ grunt build

Checklist

  • Grunt task - lint js/css (improve build task)
  • Ask for SCSS developpement option (different gruntfile)
  • Grunt task - build generation
  • Generate updated cordova (6+) project (Ask for platforms)

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

License

MIT