Apache Cordova Template App

Clone this repo:
  1. 969f9c9 chore: increment package version to 6.0.1-dev by Erisu · 9 months ago master
  2. 8430b5c release(6.0.0): updated release notes & version (app-hello-world-6.0.0) by Erisu · 10 months ago 6.0.x 6.0.0 rel/6.0.0
  3. e1b5cfb release(6.0.0): add missing license header (app-hello-world-6.0.0) by Erisu · 10 months ago
  4. 3233dc9 cleanup!(config.xml): simplify defaults (#73) by エリス · 10 months ago
  5. 17d0607 chore(version): bump 6.0.0-dev (#74) by エリス · 10 months ago

Apache Cordova Hello World Application

NPM

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:

const 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.

If you want to include .gitignore files in your template, you have to name them gitignore (without a leading dot) instead. They will be renamed to .gitignore upon template expansion.