commit	88774f1653c951855632a142b4f7ecf5ce445ab2	[log] [tgz]
author	Raphael von der Grün <raphinesse@gmail.com>	Wed May 30 04:06:28 2018 +0200
committer	Shazron Abdullah <shazron@gmail.com>	Wed May 30 10:06:28 2018 +0800
tree	75cc8922423d71f6e3735932f686853819080aa3
parent	6692d5b13237e13c8a5b5007e4581a4fe8fd8e58 [diff]

tree: 75cc8922423d71f6e3735932f686853819080aa3

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

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

var path = require('path');

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

package.json

This package.json holds information about the template itself like its name, version etc. All templates should contain the keyword "cordova:template" so that the template is searchable on npm. For example:

{
    "name": "cordova-example-template",
    "version": "1.0.0",
    "...": "...",
    "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.