foundation-apps-template v1.2.0

The Predix Mobile Sample App

##app.json App Name: Sample1

Version: 1.0

##webapp.json Web-App Name: sample-webapp

Version: 0.0.1

Background

This is the sample app for Predix Mobile.

"If you think about it like a sample of a sandwich, it contains everything in that sandwich, but it's not the whole sandwich. You wouldn't sell it to someone, but it's a taste of everything." - Matt Hoffman, Predix Mobile Developer (feat. Jon Henderson, Predix Mobile Developer)

Currently our sandwich is pretty bland, we only use the PMAPI to access test data. In the future, the sample app will be more of a Dagwood sandwich which includes a taste of all of the components that you may want in a Predix Mobile application.

About the app

The sample app is geared towards a field service engineer who is assigned a list of issues. There is a dashboard for viewing the number of issues with differing levels of severity. Tapping on one of the severities shows you a list of issues with that severity. Tapping on one of the issues shows you details about that issue. The sample app currently teaches you how to use the Predix Mobile API in the context of a web application built on top of our app contiainer.

Tech Stack

The sample app's tech stack is based on Foundation for Apps, which uses HTML5, Javascript, CSS3, AngularJS, and Sass. If you are writing your web application with Foundation for Apps, or at least AngularJS, then this code will help you with app navigation and the architecture for building mobile web apps. Foundation for Apps, AngularJS, or Sass are not required to write apps on Predix Mobile.

Running the Predix Mobile Sample App

Before You Begin:

This is the general setup for all Mobile WebApp Examples. If you have NOT worked through the getting started documentation, please use these docs for running the sample app.

Setup

This is the general setup for all Mobile WebApp Examples, but is HIGHLY recommended that you follow the getting started documentation when installing this app.

1. Create an empty directory and setup a workspace using the PM Tool.

   $ pm workspace --create

2. Clone the repo under the webapps folder in your workspace.

   $ cd <your_workspace>/webapps
   $ git clone https://github.com/PredixDev/MobileExample-WebApp-Sample.git

3. Install the app's dependencies

   $ cd <your_workspace>/webapps/MobileExample-WebApp-Sample
   $ npm install

4. Log into the PM Tool

   $ pm api <your_predix_mobile_server_address>
   $ pm auth <your_username> <your_password>

5. Build and Publish the Sample App

   $ cd <your_workspace>/webapps/MobileExample-WebApp-Sample
   $ npm run publish

6. Within your pm-apps folder create a folder called SampleApp.

   $ mkdir <your_workspace>/pm-apps/SampleApp

7. In the SampleApp folder create your app.json file. The contents should be as follows:

   {
       "name": "Sample1",
       "version": "1.0",
       "starter": "sample-webapp",
       "dependencies": {
       "sample-webapp": "0.0.1"
       }
   }

8. Load the sample data

   $ cd <your_workspace>
   $ pm import --data ./webapps/MobileExample-WebApp-Sample/test/data/data.json --app ./pm-apps/SampleApp/app.json

1. Define the Sample App

   $ cd <your_workspace>/pm-apps/SampleApp/
   $ pm define

2. Update the info.plist for the Mobile App Container in Xcode to match the app name and version in the app.json and run.