Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 2.01 KB

README.md

File metadata and controls

53 lines (36 loc) · 2.01 KB
Raw

Cordova Skeleton App

By Will Froelich

What this is

A Skeleton setup for building an iOS Cordova (phoneGap) application using:

  • Backbone.js : For a javascript framework.
  • App : Structures the Backbone application, deals with Cordova's device ready, organizes views, analtyics wrappers
  • FuelPHP : Ready to go Fuel PHP setup for getting an API going
  • Vagrant : For building a virtual environment to run your API (Pre configured to our Fuel Install)
  • Google Analytics iOS SDK & Cordova Plugin : For analytics
  • Testflight iOS SDK & Cordova Plugin : For app distribution and analytics
  • Some iOS Flavored CSS : Rapid UI Layout
  • Tappable, Spin.js, iScroll, jQuery, jQuery-UI : Stuff to make your app more nativ'y (tm)

Requirements

For testing

  • This repo
  • Xcode 4.2 > [Mac app store]
  • iOS SDK [Via XCode Downloads]
  • Cordova 1.7 [http://phonegap.com/]

To run the api server locally

How to get app running:

  1. Pull repo and initialize submodules git submodule init and git submodule update
  2. Configure /www/app/bootstrap.js
  3. Create Xcode project using the Cordova Template. Replace Cordova.plist with /frameworks/Cordova-example.plist
  4. Run in iPhone sim 4.3 >

Get API running locally

If you haven't already, you'll need a vhost with a reverse proxy setup on proto. You can check /etc/httpd/conf/vhosts/will.conf for an example

  1. Make sure you have virtualbox and vagrant installed
  2. Copy Vagrantfile-example to /Vagrantfile and modify ports
  3. cd to the repo and run vagrant up
  4. Modify /www/app/bootstrap.js turn off production mode and change dev api url to yourself.

When bringing down vagrant, if you've made changes to the database schema, while in the vhost, eg, vagrant ssh, run sh /vagrant/provision/save-state.sh. This will dump the schema and data that you can commit. You could alternatively, manually dump the db and place it in /provision/db/schema-and-data.sql.gz