Predix Design System Sample Application

Getting Started

Install tools

If you don't have them already, you'll need node, bower and gulp to be installed globally on your machine.

1. Install node. This includes npm - the node package manager.
2. Install bower globally npm install bower -g
3. Install gulp globally npm install gulp-cli -g

Install the dependencies

Change directory into the new project you just cloned, then install dependencies.

npm install
bower install

Running the app locally

The default gulp task will start a local web server. Just run this command:

gulp serve

or

npm start

Running in Predix Cloud

With a few commands you can build a distribution version of the app, and deploy it to the cloud.

Create a distribution version

Use gulp to create a distribution version of your app, which contains vulcanized files for more efficient serving. You will need to run this command every time before you deploy to the Cloud.

gulp dist

Push to the Cloud

Pre-Requisites

Pushing (deploying) to a cloud environment requires knowledge of the commands involved and a valid user account with the environment. GE uses Cloud Foundry for its cloud platform. For information on Cloud Foundry, refer to this link.

Steps

The simplest way to push the application to a cloud environment is by modifying the default manifest file (manifest.yml) and using the cf push command, as follows:

1. Update manifest.yml

   Change the name field in your manifest.yml.
   Uncomment the services section, and change the names to match your service instances. Uncomment the clientId and base64ClientCredential environment variables and enter the correct values for your UAA client.

   ---
   applications:
     - name: px-sample-app
       buildpack: nodejs_buildpack
       command: node server/app.js
   #services:
    # - <your-name>-secure-uaa-instance
    # - <your-name>-timeseries-instance
    # - <your-name>-asset-instance
   env:
       node_env: cloud
       uaa_service_label : predix-uaa
       # Add these values for authentication in the cloud
       #clientId: {Enter client ID, e.g. app-client-id, and place it here}
       #base64ClientCredential: dWFhLWNsaWVudC1pZDp1YWEtY2xpZW50LWlkLXNlY3JldA==
   

2. Push to the cloud.

   cf push
   

3. Access the cloud deployment of your application

The output of the cf push command includes the URL to which your application was deployed. Below is an example:

API endpoint: https://api.endpoint.svc.ice.ge.com (API version: 2.62.0)
User: [email protected]
Org: predix-org
Space: predix-space

Access your application by loading the API Endpoint above in a web browser

Support and Further Information

Ask questions and file tickets on https://www.predix.io/community.

Copyright

Copyright © 2015, 2016, 2017 GE Global Research. All rights reserved.

The copyright to the computer software herein is the property of GE Global Research. The software may be used and/or copied only with the written permission of GE Global Research or in accordance with the terms and conditions stipulated in the agreement/contract under which the software has been supplied.