a1626/generator-polymer-init-cordova-1.x

Polymer cli template for cordova.

generator-polymer-init-cordova-1.x

Polymer cli template for cordova. As name suggests template is for Polymer 1.x applications.

Pre-requisites

• Please make sure npm/node is installed.
• Polymer-cli

  npm install -g polymer-cli
  

• Cordova

  npm install -g cordova
  

Installation and Usage

This package is a template for polymer-cli and hence needs to be used along with same.

• To install the package use npm (Prefer installing the package globally).

  npm install -g generator-polymer-init-cordova-1.x
  

• Then in the directory where you want to create a new project use polymer init command and you will find a new package named cordova-1.x.
• Choose the package and you will be asked for some configurations in order to start your project.

Structure

 .
 ├── .bowerrc
 ├── .gitconfig
 ├── bower.json
 ├── config.xml
 ├── hooks
 │     └── Readme.md
 ├── platforms
 └── www
      ├── index.html
      ├── images
      │    └── fav.ico
      └── src
           └── my-app.html
      

Options

This project offers following options for user to configure directly from command line. Please note most of the default values are used from cordova.

• Project Name: Name of the new project to create (defaults to the folder name).
• Shell Name: Name of the main shell of the app (defaults to my-app).
• Cordova package: Package name to configure for cordova app (defaults to org.apache.cordova.<project name>).
• Advance cordova configuration: User will be provided option to further configure cordova. These configurations can be skipped (default values will be used in this case). Below are the six configurations that user can choose to opt out of:  

  • Description: A short description for the project. Same description is also used for bower.json (defaults to A sample Apache Cordova application that responds to the deviceready event.).

  • Version: Initial version of the project for cordova and bower config (defaults to 1..0.0).

  • Authors: Name of author/s contributing in app (defaults to Apache Cordova Team).

  • Author's email: Email address for of contributing author/s (defaults to [email protected]).

  • Author's href: Web page to check author's details or to reach out to them (defaults to http://cordova.io).

  • Platforms: Platforms for which cordova app needs to be configured. Following platforms are configurable

    • android: Default true.
    • ios: Default true.
    • blackberry10: Default false.
    • browser: Default false.
    • firefoxos: Default false.
    • osx: Default false.
• Proxy: In case you are behind a firewall you can choose to configure proxy for git and bower using this option.
  • http: http proxy value.
  • https: https proxy value (defaults to same value and that for http).

License

MIT © Abhishek Gupta

generator-polymer-init-cordova-1.x's Issues

Conditional cordova configuration

Cordova configuration should be optional in order to limit the number of options for users

Option for proxy.

How about adding options to configure proxies like bowerrc and npmrc for people behind firewall?

Write test cases