0x300 / kumobile

Kettering University mobile application Phonegap project (HTML, Javascript, CSS, iOS, Android, Windows)

KUMobile

KUMobile is a cross-platform mobile application project for Kettering University. The project is focused on information exchange between Kettering and the students. The application targets the following platforms: Android, iOS, and Windows.

Getting Started

Running the App

Download the latest repository and extract the www folder locally. Use a local web browser to test functionality starting with the index.html folder. To accomplish this you can start chrome with "--disable-web-security" in order to allow access to other domains. Chrome has built in emulation options available by inspecting then clicking the phone icon. Alternatively if you have setup Phonegap CLI then you can run "phonegap serve" to launch the site.

Compiling for Mobile Devices

To compile you may use Phonegap's Cloud service available at http://build.phonegap.com, choose the upload zipfile option, and provide them a zipped www folder! Another option is to use Phonegap's CLI to compile. This procedure generally requires the correct operating system and has a lot of dependencies (https://github.com/phonegap/phonegap-cli). Note: in either case you may have to change the config.xml file to have a different widget id.

Setting up CLI (optional)

The Phonegap / Cordova CLI can be useful for compiling the app locally or even for local testing.

Using the CLI for compilation will require all the tools for each platform (yes, iOS requires Mac OS and XCode). All plugins also must be downloaded locally in order to properly build. Please see install guide for the setup procedure and these docs for usage!

Documentation

Please use yui-docs comment block styling and rules! The site documentation is currently hosted at http://kumobile.info.

To generate a new set of documentation use the Build-docs.cmd script or make a similar script for Mac OS / Linux. The command should be ran relative to the kumobile root folder and should look like yuidoc -c ./yui-theme/yuidoc.json www/js -C.

License

KUMobile is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

KUMobile is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

For questions, comments, or concerns please email [email protected].