https://github.com/apache/cordova-create

Apache Cordova Create
https://github.com/apache/cordova-create

cordova cplusplus csharp java javascript library mobile nodejs objective-c

Last synced: about 1 year ago
JSON representation

Apache Cordova Create

• Host: GitHub
• URL: https://github.com/apache/cordova-create
• Owner: apache
• License: apache-2.0
• Created: 2016-07-31T07:00:06.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-11-18T22:43:51.000Z (over 1 year ago)
• Last Synced: 2025-04-03T04:16:52.475Z (about 1 year ago)
• Topics: cordova, cplusplus, csharp, java, javascript, library, mobile, nodejs, objective-c
• Language: JavaScript
• Homepage:
• Size: 16.1 MB
• Stars: 10
• Watchers: 15
• Forks: 16
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# cordova-create

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

[![Node CI](https://github.com/apache/cordova-create/workflows/Node%20CI/badge.svg?branch=master)](https://github.com/apache/cordova-create/actions?query=branch%3Amaster)

[![codecov.io](https://codecov.io/github/apache/cordova-create/coverage.svg?branch=master)](https://codecov.io/github/apache/cordova-create?branch=master)

This module is used for creating Cordova style projects. It also incudes support for [Cordova App Templates](http://cordova.apache.org/docs/en/latest/guide/cli/template.html). It can fetch templates from npm and git.

## Usage

```js

const create = require('cordova-create');

await create(dest, opts);

```

### Parameters

#### `dest`

_Required_. Path to the destination where the project will be created. Must be an empty dir if it exists.

#### `opts`

_Optional_. Supports following properties.

```js

{

    // Attributes to be set in package.json & config.xml

    id: String,

    name: String,

    version: String,

    // The path/url/package-name to the template that should be used

    template: String,

    // An EventEmitter instance that will be used for logging purposes

    // (actually it only needs to implement a compatible `emit` method)

    events: EventEmitter

}

```