Permalink
87521bf Sep 13, 2016
88 lines (61 sloc) 4.8 KB

Questions the generator will ask

The generator will ask the following questions in that order:

Name?

The name of the project will be written to the config.xml and thus show up below your app icon when you run the app on a device:

<name>Adventure Island</name>

From this name the generator also derives a compatible angular module name for the root module of your app:

app.js:

angular.module('adventureIsland', [
  // load your modules here
  'main', // starting with the main module
]);

This module is then bootstrapped in the index.html:

<body ng-app="adventureIsland">

App identifier?

A reverse-domain identifier to identify your app. If you don't know what that is, a good explanation is found in the psdpdfkit guides. For a start you can just make one up and change it later.

config.xml:

<widget id="com.company.project" ...>

Ionic CSS or Sass?

You'll be writing your own styles using Sass in any case. Your choice here is between including the Ionic styles as CSS or Sass.

No matter what choice you make, you can change this later, after project generation with the help of our Ionic style source guide.

Choosing Sass allows you to change the basic layout of Ionic. Bar heights, colors and more. However the whole Ionic Sass needs to compile with every change you make to your own Sass, which is a little slower than if you just include the compiled CSS version of the Ionic styles. So if Ionic generally suffices for your project as is, go with the CSS version.

Additional bower packages?

The angular, ionic, angular-ui-router and ngCordova bower dependencies will be installed and included by default. Additional packages you select here also get installed and injected into your index.html. Refer to their documentations for instructions on how to use them, some are covered in our Bower component usage guide.

Install new ones using the Bower CLI:

bower install angular-translate --save

Cordova platforms?

Choose the platforms you want to build for. This will only work if you have the platforms' requirements correctly set up. For more information visit Installation and Prerequisites.

You can add and remove platforms at any time using the Cordova CLI wrapper:

gulp --cordova "platform add android --save"

More detailed instructions are found in the Development Introduction. So if you're not sure, leave these empty for now. A full list of platforms supported by Cordova is found in the Cordova Documentation.

Cordova plugins?

Select the ones you want to install now. Unlike the Cordova platforms, these will not fail without the proper Cordova platform setup.

Just as with the platforms you can add plugins later at any time using the Cordova CLI wrapper:

gulp --cordova "plugin add cordova-plugin-camera --save"

Find all available plugins on the Cordova plugins page.

Starter template?

This choice decides whether your app will be generated with an Ionic side menu or Ionic tab navigation. Alternatively you may choose to generate a blank module, if you wish to build everything from the ground up.

Ecosystems?

Generator-M-Ionic provides integration into different ecosystems. For more information refer to the Ecosystems section of our Guides. If you don't know what these are, just leave them empty for now. They can be included at any time.