Apache Cordova hello world

Clone this repo:
  1. 61c3dd9 Add or update GitHub pull request and issue template by Jan Piotrowski · 8 months ago master
  2. 7516aee GH-10 Incremented package version to -dev by エリス · 10 months ago
  3. f6eb52a GH-10 Updated version and RELEASENOTES.md for release 4.0.0 by エリス · 10 months ago 4.0.x 4.0.0 rel/4.0.0
  4. ebdd908 Update index.js (#29) by faisal211 · 12 months ago
  5. 427a987 Absorb cordova-template-reference (#24) by Raphael von der Grün · 1 year, 1 month ago

Apache Cordova Hello World Application

A simple Hello World application that serves two purposes:

  • It is used as the default app template when creating new projects
  • It is a reference for building and publishing custom 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.