# cordova-runner

> Create, run, and build cordova apps

Latest version **0.0.4** (published 2017-09-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install cordova-runner
pnpm add cordova-runner
yarn add cordova-runner
bun add cordova-runner
```

Provides the commands `cordova-runner`, `check-cordova-version`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2017-09-18 |
| First published | 2017-07-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Dan Kreiger |
| Maintainers | dankreiger |

## Links

- npm: https://www.npmjs.com/package/cordova-runner
- Repository: https://github.com/dankreiger/cordova-runner
- Homepage: https://github.com/dankreiger/cordova-runner#readme
- Issues: https://github.com/dankreiger/cordova-runner/issues
- npm.io page: https://npm.io/package/cordova-runner

## Dependencies (3)

- [shelljs](https://npm.io/package/shelljs.md) ^0.7.8
- [cordova-icon](https://npm.io/package/cordova-icon.md) ^0.9.1
- [cordova-splash](https://npm.io/package/cordova-splash.md) ^0.9.0

## Recent versions

- 0.0.4 (latest) — 2017-09-18
- 0.0.3 — 2017-07-13
- 0.0.2 — 2017-07-13
- 0.0.1 — 2017-07-13

## README

<p align="center">
  <h3 align="center">Cordova Runner</h3>
  <p align="center">
    Transform html/css/js projects into iOS and Android apps.
  </p>
</p>

<br>

## Table of contents

- [Status](#status)
- [Prerequisites](#prerequisites)
- [App icons and loading screens](#app-icons-and-loading-screens)
- [Install](#install)
- [Setup](#setup)
- [Usage](#usage)


## Status
[![Build Status](https://travis-ci.org/dankreiger/cordova-runner.svg?branch=master)](https://travis-ci.org/dankreiger/cordova-runner)


## Prerequisites

Please install
- [Node >= 6.0.0 and NPM >= 5.0.0](./NODE_INSTALL.md)
- [Android Studio](https://developer.android.com/studio/index.html) (for Android development)
- [Xcode](https://itunes.apple.com/de/app/xcode/id497799835?l=en&mt=12) (for iOS development)

- Imagemagick for icon processing

``` bash
$ sudo apt-get install imagemagick
$ # on Mac: brew install imagemagick
$ # on Windows: http://www.imagemagick.org/script/binary-releases.php#windows (check "Legacy tools")
```

## App icons and loading screens

- `cordova-runner` uses the convenient [cordova-icon](https://github.com/AlexDisler/cordova-icon) and [cordova-splash](https://github.com/AlexDisler/cordova-splash) packages for icon and loading (splash) screen processing.

**App icon**
- Your app icon must be a `.png` file
- You must name it `icon.png`
- It should be square and ideally 512x512px, but no smaller than 192x192px

**Loading screen**
- Your app icon must be a `.png` file
- You must name it `splash.png`
- It should be 2208x2208 px with a center square of about 1200x1200 px.

- Please copy your `icon.png` and `splash.png` to the root of your project before using `cordova-runner`.

## Install

```bash
$ npm install -g cordova-runner
```

## Setup

- `cd` into your `html/css/js` project.

  - A generic project structure might look something like this:

  ```bash
  .
  ├── css
  │   ├── style.css
  │   └── theme.css
  ├── img
  │   └── image.png
  ├── js
  │   ├── custom.js
  │   └── theme.js
  ├── about.html
  ├── contact.html
  ├── icon.png
  ├── index.html
  └── splash.png

  ```


  - **Note:** Your root html **must** be called `index.html`. Please rename your root html file if you have to.


## Usage:

1. Run in your terminal:
```bash
$ cordova-runner
```

2. After that, just follow the prompt.

---
_Source: https://npm.io/package/cordova-runner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._