A generator for the Ionic Framework
Yeoman generator for Ionic - lets you quickly set up a hybrid mobile app project
npm install -g generator-ionicjs
Make a new directory, and
cd into it
mkdir my-ionic-project && cd $_
Follow the prompts to select from some common plugins and pick a starter template, then spin up a
connect server with
livereload for developing in your browser
Make sure you've commited (or backed up) your local changes and install the latest version of the generator via
npm install -g generator-ionicjs, then go ahead and re-run
yo ionicjs inside your project's directory.
The handsome devil is smart enough to figure out what files he is attempting to overwrite and prompts you to choose how you would like to proceed. Select
Y for overwriting your
bower.json to stay up-to-date with the latest workflow goodies and front-end packages.
The included Grunt build system provides sensible defaults to help optimize and automate several aspects of your workflow when developing hybrid-mobile apps using the Ionic Framework.
Install a new front-end library using
bower install --save to update your
bower install --save lodash
This way, when the Grunt
bower-install task is run it will automatically inject your front-end dependencies inside the
bower:js block of your
build:css blocks but outside the
bower:css blocks (since the Grunt task overwrites the Bower blocks' contents).
grunt serve enhances your workflow by allowing you to rapidly build Ionic apps without having to constantly re-run your platform simulator. Since we spin up a
connect server with
Once you're ready to test your application in a simulator or device, run
grunt cordova to copy all of your
app/ assets into
www/ and build updated
platform/ files so they are ready to be emulated / run by Cordova.
To compress and optimize your application, run
www/ directory so the compressed version can be used with Cordova.
To make our lives a bit simpler, the
cordova library has been packaged as a part of this generator and delegated via Grunt tasks. To invoke Cordova, simply run the command you would normally have, but replace
: (the way Grunt chains task arguments).
For example, lets say you want to add iOS as a platform target for your Ionic app
and emulate a platform target
or add a plugin by specifying either its full repository URL or namespace from the Plugins Registry
grunt plugin:add:grunt plugin:add:org.apache.cordova.devicegrunt plugin:add:org.apache.cordova.network-information
To help you hit the ground running, let's walk through an example workflow together. We're assuming you've followed the usage directions and are inside your app's directory.
We'll start by running our app in a browser so we can make a few changes.
Play around with livereload by changing some of the styles in
app/styles/main.css or HTML in one of the files in
app/templates/. When you're ready, lets go ahead and build the assets for Cordova to consume and also spot check that we didn't bork any code during the build process. We can do that with another handy Grunt task that runs the build process and then launches a
connect server for use to preview the app with our built assets.
If everything looks good the next step is to add a platform target and then emulate our app. In order for us to launch the iOS simulator from the command line, we'll have to install the
ios-sim package. (If you forget to do this, Cordova will kindly remind you).
npm install -g ios-simgrunt platform:add:iosgrunt emulate:ios
You may have realized that when the Grunt build process is run, it triggers the Cordova build system as well, so you end up with a beautifully packaged mobile app in a single command.
To lessen the pain of testing your application, this generator configures your project with a handful of libraries that will hopefully make testing your application, dare I say, more enjoyable.
The foundation of our testing solution is built using Karma which was created by the AngularJS team and is all around awesome. Inside of your generated
karma.conf.js file you will find some basic configuration settings. Notice that we're using Mocha to structure our tests and pulling in Chai, a slick assertion library. You can easily drop Chai and replace Mocha with Jasmine depending on your preference.
Gruntfile.js also contains a
karma task that provides further configuration. Any properties specified via this task will override the values inside
karma.conf.js when run via
grunt. If you look closely at this task, you'll notice that we're using PhantomJS for both Karma targets, but you can easily update the
karma:unit target to run tests inside of real browsers.
Ok, now that you have some context (and links to read up on the bundled testing libraries), go ahead and run
grunt test and open up one of the included unit tests -
test/spec/controllers.js. In your editor of choice, change this line -
scope.pets.should.have.length(4); to any number other than four and watch what happens. Since your test files are being watched for changes, Grunt knows to go ahead and re-run your test suite, which in this cause should have errored out with a failure message being displayed in your terminal.
Undo your modification and ensure that all tests are passing before continuing on.
Note Depending on which starter template you picked, your tests may start off failing.
So you've finished writing your tests, why not showoff just how watertight your application has become? Using Istanbul - which was built at Yahoo - we can generate visually engaging code coverage reports that do just that!
Our beloved generator has done all the hard work for you, so go ahead and see these coverage reports in action by running
If this is your first time using Istanbul, take a look around. It will help you spot gaps in your unit tests and lets face it, the more visual gratification we can get during our testing stage, the greater the likelihood of us sitting down and writing these tests to begin with!
If you made it this far then congratulations! You're now up and running with the gorgeous Ionic Framework powered by an intelligent workflow and sophisticated build system - all facilitated by the addition of just a few commands!
Be Advised: Ripple is under active development so expect support for some plugins to be missing or broken.
Add a platform target then run
grunt ripple to launch the emulator in your browser.
grunt platform:add:iosgrunt ripple
Now go edit a file and then refresh your browser to see your changes. (Currently experimenting with livereload for Ripple)
Note: If you get errors beginning with
Error: static() root path required, don't fret. Ripple defaults the UI to Android so just switch to an iOS device and you'll be good to go.
- The pioneers behind Yeoman for building an intelligent workflow management solution.
- The AngularJS Generator and Ionic Seed Project projects for inspiration.
- The visionaries at Drifty for creating the Ionic Framework.
See the contributing docs.
When submitting a PR, make sure that the commit messages match the AngularJS conventions.