diff options
| -rw-r--r-- | README | 41 |
1 files changed, 33 insertions, 8 deletions
@@ -1,11 +1,36 @@ -BUILDING ---------- +FixMyStreet Mobile App +---------------------- -The cordova.sj file in www is for bilding on the iPhone. In order -to build on android you need to replace it with the android_cordova.js -file in this directory. +This is the FixMyStreet mobile app for reporting problems to an instance of the +FixMyStreet platform - https://github.com/mysociety/fixmystreet. -If you Build on android and see an error about Cordova.exec before deviceready -then it's likely that you have forgotten this step. +It's still in development at the moment. -To build on iPhone copy the iphone_cordova.js over the cordova.js in www. +The FixMyStreet mobile app uses PhoneGap and has versions for Android and iOS. + +Running +------- + +To get it up and running you will need to create a config.js file in www/js/ based +on the www/js/config-example.js file. This has configuration for which FMS instance +to use etc. + +You should then be able to build and run it like any other PhoneGap project. + +The app works out which version of the PhoneGap JavaScript file to use and loads +it dynamically - see www/cordova-independant.js for details. + +Basic structure +--------------- +Android - android project +iPhone - iOS version +www - JS, HTML, CSS and image files + +www Stucture +------------ +css - css files +js - project javascript files +js/views - backbone view files +js/models - backgone model files +jslib - third party javascript libraries and files +templates - underscore templates for the pages |