[DEPRECATED] Apache cordova template reference repo

Clone this repo:

Branches

  1. 501f5ef deprecation by Jan Piotrowski · 1 year, 5 months ago master
  2. 6454028 Update deprecation notice to latest version by Raphael von der Grün · 2 years, 1 month ago
  3. 9de1efd Add deprecation notice to README (#4) by Raphael von der Grün · 2 years, 1 month ago
  4. 88774f1 Remove deprecated hooks directory (#3) by Raphael von der Grün · 2 years, 4 months ago
  5. 6692d5b Fix indentation (#1) by Raphael von der Grün · 2 years, 4 months ago

📌 Deprecation Notice

This repository is deprecated and no more work will be done on this by Apache Cordova. You can continue to use this and it should work as-is but any future issues will not be fixed by the Cordova community.

Feel free to fork this repository and improve your fork. Existing forks are listed in Network and Forks.


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.