kevinsimard / cordova-app

Cordova application structure

Cordova Application Structure

Installation

This structure utilizes Npm and Bower to manage its dependencies. So, before using it, you will need to make sure you have both of them installed on your machine.

Once installed, run the following commands to install the dependencies.

$ npm install
$ bower install

Gulp Tasks

Developement environment(s)

$ gulp dev

The following options are available:

• --watch: Rerun subtasks when a file changes
• --env=<ENV>: Override default configuration file
• --serve: Built-in static server for basic HTML/JS/CSS websites

Production environment(s)

$ gulp www

The following options are available:

• --env=<ENV>: Override default configuration file

Unit Tests

Note: Make sure that dependencies are installed ($ npm install).

The unit tests are available with $ npm test which is actually a shortcut for $ gulp test.

Code Structure

├── dev
│   ├── app
│   │   ├── components
│   │   │   └── layout
│   │   │       ├── directives
│   │   │       │   ├── footer.js
│   │   │       │   └── header.js
│   │   │       └── templates
│   │   │           ├── footer.tpl
│   │   │           └── header.tpl
│   │   ├── modules
│   │   │   └── lang
│   │   │       ├── factories
│   │   │       │   └── translate.js
│   │   │       ├── locales
│   │   │       │   └── en.json
│   │   │       ├── subscribers
│   │   │       │   └── locale.js
│   │   │       ├── .gitignore
│   │   │       ├── config.js
│   │   │       └── module.js
│   │   ├── views
│   │   │   └── index
│   │   │       ├── controllers
│   │   │       │   └── index.js
│   │   │       ├── templates
│   │   │       │   └── index.tpl
│   │   │       └── states.js
│   │   ├── .gitignore
│   │   ├── bootstrap.js
│   │   ├── module.js
│   │   └── states.js
│   ├── assets
│   │   ├── docs
│   │   │   └── .gitkeep
│   │   ├── fonts
│   │   │   └── .gitkeep
│   │   ├── images
│   │   │   └── .gitkeep
│   │   ├── scripts
│   │   │   └── .gitkeep
│   │   └── styles
│   │       └── .gitkeep
│   ├── .gitignore
│   ├── .htaccess
│   ├── favicon.ico
│   └── index.html
├── gulp
│   └── tasks
│       ├── stubs
│       │   ├── constant.ejs
│       │   ├── locale.ejs
│       │   └── template.ejs
│       ├── browsersync.js
│       ├── constant.js
│       ├── copy.js
│       ├── jshint.js
│       ├── locale.js
│       ├── minify.js
│       └── template.js
├── test
│   ├── coverage
│   │   └── .gitignore
│   └── specs
│       ├── components
│       │   └── layout
│       │       └── directives
│       │           ├── footer.js
│       │           └── header.js
│       ├── modules
│       │   └── lang
│       │       ├── factories
│       │       │   └── translate.js
│       │       └── subscribers
│       │           └── locale.js
│       └── views
│           └── index
│               ├── controllers
│               │   └── index.js
│               └── states.js
├── www
│   └── .gitignore
├── .bowerrc
├── .editorconfig
├── .env.example
├── .env.json
├── .gitattributes
├── .gitignore
├── .jshintrc
├── .travis.yml
├── LICENSE.md
├── README.md
├── bower.json
├── config.xml
├── gulpfile.js
├── karma.conf.js
└── package.json

License

This package is open-sourced software licensed under the MIT license.