benbalter / add-to-org-demo

A demo app implementing the add-to-org Ruby gem

Add to Org Demo

A demo app implementing the add-to-org Ruby gem

Usage:

1. Fork this repository
2. Customize the validation logic in my_app.rb
3. Optionally, customize the views in the views folder with your own templates
4. Follow the instructions in the add-to-org documentation for creating the necessary access credentials
5. Deploy the app, setting the proper environmental variables created in step 4.

For more information, see the add-to-org documentation.

To set up your local development environment, clone the repo and run script/bootstrap. You'll need a working Ruby install.

Running the server

The app is designed to be deployed to places like Heroku or CloudFoundry. To run the server locally, run script/server.

Running tests

This demo app includes an example test to confirm that your validation method works. The test lives in the /spec folder and will need to be customized to your app. To run the tests, run script/cibuild or configure Travis CI to test your repo with the included .travis.yml file.