Pivotal Life is an information radiator for Pivotal Labs offices. It shows information like the weather, public transportation schedules & status, upcoming office events, tweets and random Pivots.
For example, the NYC office dashboard can be viewed at http://pivotal-life.cfapps.io/nyc. You will need a username/password to log in. It can be retrieved using the populate-dotenv.sh script described below, which requires access to the pivotallabs organziation and pivotal-life space on Pivotal Web Services. To request access, email ask.
You will need the following to develop and run the dashboard locally:
On Mac you can install NodeJs, PhantomJs and CloudFoundry with the following:
$ brew install node
$ brew install phantomjs
$ brew tap pivotal/tap # Add pivotal tap if it's not already there
$ brew install cloudfoundry-cli
To checkout and run the project locally:
$ git clone [email protected]:pivotal/pivotal-life.git
$ cd pivotal-life
$ bundle
$ npm install -g coffee-script
Note on use of bundle in deployment mode, if you are modifying the Gemfile:
$ rm Gemfile.lock
$ bundle install # recreates the lock file
$ bundle install --deployment
To run the dashboard you will need a .env file with various tokens and keys. The fastest way to do this is by pulling them down from Cloud Foundry.
First, target the pivotal-life app on the public Cloud Foundry deployment:
$ cf api api.run.pivotal.io
Then log in to Cloud Foundry:
$ cf login
If you belong to more than one org, select the pivotallabs org.
If you have access to more than one space, select the pivotal-life space.
You may need an account. Go here(http://run.pivotal.io/) to grab one!
Next, build a .env file using the Cloud Foundry settings:
$ ./populate-dotenv.sh
Several of the jobs need tokens and URLs that are in the .env file.
If you need to add custom variables, you may do so by modifying varlist.
populate-dotenv.sh has functionality to either use varlist or append it to the .env from CF settings.
Now run the local server:
$ bundle exec dashing start
Then navigate to http://localhost:3030/ for the default dashboard or http://localhost:3030/nyc to see NYC's.
Log in to basic auth using the AUTH_USERNAME and AUTH_PASSWORD from the .env file.
If you see openssl errors when running locally:
$ brew postinstall openssl
TODO: Figure out what is touching /usr/local/etc/openssl/cert.pem
If you'd like to add your own office's dashboard, do the following:
- Fork the project.
- Under the
dashboardsdirectory, create an.erbtemplate for your office. - Add any widgets that you'd like to make use of.
- Any office specific data should be stored in
offices.ymland can be read with theOfficesandOfficeclasses. - Run
raketo run the tests pass. - Commit your code.
- Make a pull request.
- Once your pull requests is merged you'll see your changes on the staging environment.
The application is automatically pushed to the staging environment once the build has passed on Travis CI.
Once you've checked your changes on the staging environment, you can push to Production by doing the following
$ cf push pivotal-life
Navigate to http://pivotal-life.cfapps.io/
The accounts for this app should be associated with the Pivotal Life Google group.
This application uses the following:
- Google API Client - used for Calendar
- Forecast.io
- SF 511
- Yelp - currently defunct
- TomTom - appears to be unused
- Use the hashtag "#pivotallife" (case insensitive)
- Only Tweets with pictures will appear in the feed
- You must add your Twitter handle to your Pivots profile
- CF requires the ruby version to be in the Gemfile
- If you need to upgrade your ruby version, make sure to change both the .ruby-version file, Gemfile, and .travis.yml