wcjohnson11 / gmajormobile

Mobile UI for gMajr

GMajor Mobile

Music is the universal language

Table of Contents

1. Introduction
2. Wiki
3. Website
4. [Database Setup](#Database Setup)
5. [Local Setup](#Local Setup)
6. Deployment Setup
7. Requirements
8. Development
   1. Installing Dependencies
   2. Tasks
9. Contributing
10. Style

Introduction

This is an ionic app that runs on Safari for iOS7 and Chrome 36+. The backend is a MongoDB database served by mongolab. The DB is controlled by the Node.js MongoDB Driver. The Web Audio API is used to generate sounds without using recorded samples. While it can be built down to a web site for testing purposes, it's expected to be run on a moble device.

Website

Product website can be found here and is still in development.

Wiki

The Wiki contains information about the structure and usage of the app.

Database Setup

The app depends on a MongoDB server for storage. If you plan to deploy with Azure, you should follow the instructions in Azure Deployment, which will include setting up your DB. Even if you don't, you need to set up a MongoDB server if you want to test and develop with a working database. We recommend creating a mongolab account, as the mongolab setup is documented in Setting up MongoDB with Mongolab

Local Setup

1. sudo npm install -g bower
2. npm install
3. bower install
4. npm install -g ionic
5. gulp (concatenates js files, serves the app at localhost:8080, watches for file changes and recompiles them and restarts server as needed)

Deployment Setup

See Azure Deployment

Requirements

• Ionic 1.0.0-beta.9 "gadolinium-gator" for mobile framework
• Apple xcode for iOS building / testing
• Gulp

Development

Installing Dependencies

To build / test for iOS you need a Macintosh computer. Install XCode from the Apple app store here: https://itunes.apple.com/us/app/xcode/id497799835?mt=12

To build / test with Android you need the Android SDK available here: http://developer.android.com/sdk/index.html (I recommend installing the link for the stand-alone SDK rather than the one bundled with Eclipse)

To build and test in a web browser: gulp serve-ionic

To build and test on iOS: ionic emulate iOS

To build and test on Andriod: ionic emulate android

If emulation for a device fails. You should remove that platform and add it again. For instance: cordova platform remove ios

and then cordova platform add ios

Tasks

See the projects backlog in asana here

Contributing

See CONTRIBUTING.md for contribution guidelines.

Style

See the Style Guide