Skip to content

SlovakNationalGallery/soundwalk-filko

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Filko Audio Guide

image _GAL0555

This Audio Guide accompanies the 'STANO FILKO: POETRY ON SPACE – COSMOS' exhibition at the Slovak National Gallery, 24 June - 25 September 2016. It is an open source mobile application built using PhoneGap (Apache Cordova), written entirely in HTML, CSS and JavaScript, and runs on numerous platforms (tested for iOS and Android).

The app uses:

Installation

Requires Node.js

npm install -g phonegap
npm install  -g cordova-splash
phonegap plugin add cordova-plugin-media
phonegap plugin add cordova-plugin-inappbrowser
phonegap plugin add cordova-plugin-device
phonegap plugin add cordova-plugin-globalization
phonegap plugin add cordova-plugin-nativestorage
phonegap plugin add cordova-plugin-statusbar
phonegap plugin add cordova-plugin-splashscreen
phonegap plugin add cordova-plugin-mixpanel

Usage

To start a local server to run the app in your browser:

phonegap serve

To test on your phone you can download the nifty PhoneGap Developer mobile app and point it to the Server Address you see after starting phonegap serve.

In case you receive an Unable to download archive from the server error in the PhoneGap Developer mobile app, it might help to create a WiFi hotspot on your phone, join this network on your computer, restart phonegap serve and connect again. See this issue on Github for details.

Event tracking with Mixpanel

We use Mixpanel to track basic usage of the app. The unique Mixpanel token is stored in www/secrets.json, which looks like:

{
    "mixpanelProductionToken":"YOUR_PRODUCTION_TOKEN_HERE"
    "mixpanelDevelopmentToken":"YOUR_DEVELOPMENT_TOKEN_HERE"
}

Building Native Apps

More info on how to use Cordova to build native apps for various platform can be found on the Cordova CLI documentation. Since this app is already structured as a cordova app, you can skip straight to adding platforms.

To generate splash-screens for all platforms (after platforms have been added):

cordova-splash

Troubleshooting

iOS crash on start

When crashes occur on startup (we encountered this on iOS8/iPhone5), this might be caused by an unincluded framework used by Mixpanel.

To solve it, open app in XCode -> General tab -> Linked Frameworks and Libraries -> Add Watchkit.framework