Welcome to the giv2giv.org API

This API provides endpoints for the giv2giv.org fund software. It uses Ruby 1.9.3, Rails and MySQL.

Getting Started

1. Install pre-requisites apt-get install nodejs

2. Install Ruby # We use rvm rvm install ruby-2.1.2

3. Install gems bundle install

4. Set config/app.yml variables

5. Setup your database (If this doesn't work, then you may need to install mysql, and/or change the information in config/database.yml.)

    rake db:setup
   

6. Start the server!

    rails s
   

You're off and running. Use your new API with a client like https://github.com/giv2giv-jquery or curl. See Curl Examples for endpoint detail.

Contributing

Want to help out on development? Feel free to fork us, make changes, and submit pull requests!

Grab an open issue or contact us to find out what we could use help with.

Contact Us

giv2giv website

email