golyo88 / simulator

Simulator

This is a sample application demonstrating the Xively platform.

Installation

The simplest and recommended method of installation is through Heroku. Simply click the button below.

Local Installation

If you would like to run the app locally, check your system requirements, clone this repository, and run the following from the command line:

# You only need to run the following two commands once
npm install
npm run provision
# This must be run each time you want to work on the project
npm run dev

Navigate to http://localhost:5000/ in your browser to access the app. The application will automatically refresh as you make changes to the source code.

Heroku Installation

If you are making changes to this repo or a fork of it you'll need commit the built client files to deploy it. You can follow this script as an example.

git clone [email protected]:my-github-user/simulator.git
cd simulator
git checkout -b my-changes
# make your changes
npm run dev
# test your changes
git add .
git commit
git checkout -b my-changes-heroku
npm run build
# public is normally ignored in git
git add public --force
git commit -m "Build"

Then you can push to your heroku instance from a heroku-cli set remote.

git push heroku my-changes-heroku:master --force

Or deploy a from scratch copy by pushing to your fork and deploying with https://heroku.com/deploy.

git push origin my-changes-heroku
# https://heroku.com/deploy?template=https://github.com/my-github-user/simulator/tree/my-changes-heroku

Updating Data-Flow Dependencies (habanero)

Since data flow is a seperate application, to obtain updates from that repository, you can run the following commands to force a rebuild, replacing my-changes-heroku with the branch of the simulator you are using.

heroku config:set NODE_MODULES_CACHE=false
git commit -am 'disable node_modules cache force rebuild' --allow-empty
git push heroku my-changes-heroku:master --force

Developer Scripts

There are a handful of npm scripts to aid in development.

• build – build the client app to the public
• build:watch – build the client app to the public and watch for changes
• clean – delete the public folder
• dev – run a development version of the app and watch for changes
• lint – lint JavaScript files
• local-provision – configure the app to run locally
• start – start the Node server
• start:watch – start the Node server and restart on file changes
• syncdb – sync database, create tables
• test – run all tests
• test-client – run client tests
• test-client:watch – run client tests and watch for changes
• test-server – run server tests

Configuration

Environment Variables

• XIVELY_IDM_HOST
• XIVELY_TIMESERIES_HOST
• XIVELY_BROKER_HOST
• XIVELY_ACCOUNT_ID
• XIVELY_IDM_EMAIL_ADDRESS
• XIVELY_IDM_PASSWORD
• XIVELY_MQTT_USERNAME
• XIVELY_MQTT_PASSWORD
• HABANERO_EMBEDDED

Salesforce Integration

This application can be used to demonstrate Xively's integration with Salesforce. To try that out, set up your Salesforce account as follows:

1. Create a Salesforce account
2. Install this Salesforce package: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t36000000HRMn

Now that your Salesforce account is set up, it's time to configure the application. This process is different depending on whether you're setting things up locally or if you'll be running it on Heroku.

Heroku

1. Log into Heroku
2. Navigate to this application
3. Insert your Salesforce credentials into the dashboard, and save the changes
4. When the application restarts, it will upload a Contact and the devices as Assets to Salesforce

Local development

1. Be sure that you've provisioned the app before. If you have, then you will have a .env file.
2. Open up .env and add three new fields:

• SALESFORCE_USER: your Salesforce username. This is generally an email.
• SALESFORCE_PASSWORD: your Salesforce password
• SALESFORCE_TOKEN: your Salesforce token. To find this, follow the guide here

3. Restart the Node application. It will upload a Contact and the devices as Assets to your Salesforce account

Branches and Release notes

New development

All new development must be done outside of the release workflow branches (staging/beta/master). Small changes can be done directly in the development branch, while feature work should be done in individual feature branches. Individual feature branches should be reviewed before they are merged back into the main development branch.

Pull Requests are not to be merged into master without first being confirmed by QA. After your PR is reviewed, merge your PR into the staging branch. Then cut a new build release into staging-build.

Staging

Deploy the staging branch

(NOTE: You will have to run npm run build & add the public folder by force git add public --force)

Beta

The beta branch represents the latest and greatest stable code available for public consumption, with the expectation that it may or may not be production-approved. When a staging branch has been QA'd and no regressions/outstanding issues are found, then the staging branch can be built directly into the beta branch. After you've done that, tag beta with the latest version number.

git tag -a v1.1 -m "write a note about what this version includes"
git push origin v1.1

Deploy the beta branch.

Master

The master branch is the latest production-approved code that is the standard for general use. This will be periodically updated from the beta branch by stakeholder request, with all accompanying documentation. The update is performed by copying the beta branch over to master, as both are directly built branches.

Release notes

If you want to include release notes between each tagged version, you can get a list of commits using this command:

git log v1.0..v1.1

This will give you all the commits made between those 2 versions.

Tags are like branches, so you can also do that with any branch. For example if you want to see how many commits staging is ahead of master:

git log master..staging

System Requirements

• Heroku & Heroku CLI

  • heroku account with creditcard attached to account

• Node >4

  • http://nodejs.org (All Platforms)
  • brew install node via Homebrew (OSX)
  • apt-get/yum install node (Linux)