jperla / actioncenter-mobile

2.0

EFF Alerts

Ionic app for receiving and handling push notifications.

Table of Contents

• Background Info
• Getting Started
• Setting up Cordova
• App Configuration
• Run tests
• Running the server
• Running on device
• Angular App

Background Info

EFF Alerts is a pager style app that notifies EFF supporters when EFF needs their help.

Although it works on both iOS and Android, the app is only targeting Android as of today. If you need to deploy to iOS as well, please check out the Ionic docs or contact the project maintainer for help.

The app is written using Cordova / Ionic, deploying an Angular webapp inside a UIWebView. This is to reduce the maintenance involved in managing multiple languages and fit with the existing EFF team's expertise.

Getting started

npm install
bower install
gulp build

Setting up Cordova

Install the Cordova CLI tools

sudo npm install -g cordova

Set cordova dependencies up for the app

cordova platform add android
// Required as the localnotification plugin doesn't install correctly via the install_plugins hook
cordova plugin add de.appplant.cordova.plugin.local-notification && cordova prepare

App Configuration

App config is controlled via the node-config module.

To set push credentials, create a local.json file under the config dir and override the CREDENTIALS setting.

Alternately, you can use:

• Environment variables
• Command line options

Run tests

gulp test

Running the server

Spins up a local server to serve the app.

NOTE: the app assumes the presence of various plugins that a browser doesn't have, so some actions, e.g. share buttons etc. will not work and will throw errors

gulp watch

Running on device

Gulp exposes two helper methods for running on device, these just wrap the respective ionic commands

gulp runAndroid
gulp runIos

Angular app

See the www/README.md for details