Setup

Deploying to Heroku using the Heroku Button

You can deploy your own version of Nibs in seconds using the Heroku button below:

Deploying to Heroku using the Command Line

You can also deploy Nibs to Heroku using the command line:

1. Clone the repository

   git clone https://github.com/heroku/nibs
   

2. Create a Heroku application

   cd nibs
   heroku create
   

3. Install the Postgres plugin

   heroku addons:add heroku-postgresql:dev
   

4. Deploy to Heroku

   git push heroku master
   

5. Run the the application:

   • Open the application in a browser:

     heroku open
     

   • Click the Signup button to create an account

   Facebook login won't work until you complete the Facebook integration steps described below.

Installing a Local Version

You can also install Nibs on your local machine:

1. Clone the repository

   git clone https://github.com/heroku/nibs
   

2. Install the server dependencies

   cd nibs
   npm install
   

3. Create a local database

   • Install and start Postgres on your local machine
   • Create a database called nibs
   • If your database is available using postgres://@127.0.0.1:5432/nibs, you have nothing else to do
   • If you use another database URL, either define a shell environment variable called DATABASE_URL, or modify server/config.js to provide your own default URL

4. Start the server

   node server
   

5. Run the application

   • Open a browser and access the following URL: http://localhost:5000
   • Click the Signup button to create an account

   Facebook login won't work until you complete the Facebook integration steps described below.

Facebook Integration

1. Create a Facebook application

   • Login to Facebook
   • Access https://developers.facebook.com/apps, and click Create New App
   • Specify a unique Display Name and a Category, and click Create App
   • Click Settings in the left navigation
   • Click the Advanced Tab
   • In the Security section, add the following URLs in the Valid OAuth Redirect URIs field: http://[YOUR-HEROKU-APP-NAME].herokuapp.com/oauthcallback.html http://localhost:5000/oauthcallback.html (for local installation) https://www.facebook.com/connect/login_success.html (for access from Cordova)
   • Click Save Changes

2. Change the Nibs configuration to use your Facebook app

   • Open nibs/client/config.js
   • Replace YOUR_FB_APP_ID with the id of the Facebook app you just created

3. Push the change to Heroku

Building the Cordova Shell

Follow the instructions below to run the application as an app on your device:

1. Install Cordova:

   npm install -g cordova
   

   On a Mac, you may have to use sudo:

   sudo npm install -g cordova
   

2. Create the cordova application

   cordova create nibs-shell com.nibs.loyalty Nibs
   

3. Adjust the contents of the www folder

   Either copy the contents of nibs/client into nibs-shell/www or delete www folder in nibs-shell and create a symbolic link to nibs-shell/www.

   For example, on a Mac:

   cd nibs-shell
   rm -rf www
   ln -s [path-to-nibs]/client www
   

4. Install the Cordova plugins

   Make sure you are in the nibs-shell directory and type:

   cordova plugins add org.apache.cordova.device
   cordova plugins add org.apache.cordova.console
   cordova plugins add org.apache.cordova.statusbar
   cordova plugins add org.apache.cordova.geolocation
   cordova plugins add org.apache.cordova.dialogs
   cordova plugins add org.apache.cordova.inappbrowser
   

5. Add a platform

   For example, to add the iOS platform, type:

   cordova platforms add ios
   

6. Build the project

   For example, to build for the iOS platform, type:

   cordova build ios
   

7. Run the app in the emulator or on your device. For example, for iOS, open the project (platforms/ios/Nibs.xcodeproj) in Xcode and run it in the emulator or on your iOS device.