Git Product home page Git Product logo

ember-cordova's Introduction

Ember Cordova

Build Status

ember-cordova simplifies building Cordova and Crosswalk applications with Ember.js.

It includes a CLI for builds, hooks, device event bindings, and handles splash screens, icons and a growing number of supported Ember/Cordova plugin bindings.

  1. Platforms & Requirements
  2. Getting Started
  3. Features and Documentation;
  4. Upcoming Extensions;
  5. Contributing;
  6. Credits

Platforms & Requirements

  • Ember 1.13 & above. Lower will probably work but is untested;
  • node 0.12 & above. 0.11/10 will probably work, but are untested;

Getting Started

If you are migrating from ember-cli-cordova, read the migration guide.

  ember install ember-cordova

You can optionally pass the following params:

  • name: AppName (defaults to your ember app name)
  • cordovaid: String (defaults to your app name)
  • templatePath: String path to cordova template
ember install ember-cordova --name=AppName
--cordovaid=com.isleofcode.app --templatePath=../template

If you already have a Cordova project at ember-cordova/cordova it will not be overwritten.

  1. Set your config.locationType to 'hash'.

  2. Cordova requires relative asset paths so check that none of yours are absolute. For ember-cli v2.7.0 and newer, you'll want to remove the references to {{rootURL}} from the asset paths in app/index.html.

  3. As a final step, add your desired platforms, e.g.:

ember cdv:platform add ios
ember cdv:platform add android
ember cdv:platform add browser #experimental

Cordova working relies on the cordova.js script being injected. By default, this happens using ember cdv commands. Your vanilla ember build && ember s commands will not inject cordova.js by design.

A note on browser platform

Some cordova/phonegap plugins have browser fallbacks. For example phonegap-plugin-barcodescanner will ask you to manually type the barcode value. Using the browser platform, you'll be able to develop your cordova app as it was a regular ember app.

Features and Documentation

Upcoming Extensions

We are working on four major items right now:

  1. Improving test coverage;
  2. Bindings to Cordova Plugins see plugins; and
  3. Either having ember install ember-cordova-plugin-foo install both the ember addon & cordova plugin, or achieving the same through ember cdv:install foo.

Contributing

PRs are very welcome. You can read our style guides here.

If you are unsure about your contribution idea, please feel free to open an Issue for feedback.

Credits

ember-cordova is maintained by Isle of Code, and started as a fork of ember-cli-cordova.

ember-cordova's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.