Google Git
Sign in
apache / cordova-template-reference / b2a185b6a125d05418e0d05f152d838d65f391ce
commitb2a185b6a125d05418e0d05f152d838d65f391ce[log] [tgz]
authorCaryn Tran <caryn.tran@berkeley.edu>Tue Jun 28 15:12:24 2016 -0700
committerGitHub <noreply@github.com>Tue Jun 28 15:12:24 2016 -0700
tree5fdbc922951c83048a06484c99843a86103e8d8a
parentc06ce2708f9e5a3a1ce1933203dd0256598b3c66 [diff]
Update package.json
1 file changed
tree: 5fdbc922951c83048a06484c99843a86103e8d8a
  1. template_src/
  2. index.js
  3. LICENSE
  4. package.json
  5. README.md
  6. template_docs.md
README.md

Cordova Template Reference

This is a reference for building and publishing Cordova Templates.

Structure of your template

template_package
├── package.json (for your template package to be published on npm)
├──	index.js
└── template_src (contains template files)
    ├── package.json 
	├── config.xml 
	└── (files and folders that make up the template)

Outside of template_src

All files outside of template_src are used to define parameters about the template. These files are not copied over at creation, so feel free to add a README or any other files outside of template_src.

index.js points to where the template exists. You'll see that index.js usually looks like:

var path = require('path');

module.export = {
    dirname = path.join(__dirname, 'template_src')
};

package.json tells you about the template. It is necessary state that "main": "index.js" so that the reference to the template source in index.js is propagated. All templates should contain the keyword "cordova:template" so that the template is searchable on npm.

...
"main": "index.js",
...
"keywords": [
"cordova:template"
...

Inside of template_src

All files inside of template_src compose the template from which a user would desire in order to create their project. Everything in this folder is copied over to the created project.

(The package.json in template_src should be filled with information that describes the project that would be created from the template.)