https://github.com/apache/cordova-app-hello-world

Apache Cordova Template App
https://github.com/apache/cordova-app-hello-world

cordova css hacktoberfest html javascript mobile nodejs

Last synced: about 1 month ago
JSON representation

Apache Cordova Template App

• Host: GitHub
• URL: https://github.com/apache/cordova-app-hello-world
• Owner: apache
• License: apache-2.0
• Created: 2012-11-28T08:00:29.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2022-09-08T04:40:14.000Z (about 2 years ago)
• Last Synced: 2024-10-01T01:06:36.637Z (about 1 month ago)
• Topics: cordova, css, hacktoberfest, html, javascript, mobile, nodejs
• Language: CSS
• Homepage: https://cordova.apache.org/
• Size: 13.1 MB
• Stars: 195
• Watchers: 29
• Forks: 216
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Apache Cordova Hello World Application

[![NPM](https://nodei.co/npm/cordova-app-hello-world.png)](https://nodei.co/npm/cordova-app-hello-world/)

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

```text

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:

```javascript

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:

```json

{

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