Ohana API is a Ruby on Rails application that makes it easy for communities to publish and maintain a database of social services, and allows developers to build impactful applications that serve underprivileged residents.
This is the API + Admin Interface portion of the Ohana API project, developed by @monfresh, @spara, and @anselmbradford during their Code for America Fellowship in 2013, in partnership with San Mateo County's Human Services Agency.
The Ohana project also comes with a web-based search interface that allows anyone to easily find services that are available in a particular community.
Development Road Map for 2014
As a winner of the Knight News Challenge (Health edition), the Ohana project received a grant from the Knight Foundation, which allowed us to improve the project, and prepare it for broader installation by a variety of organizations and governments.
We've fulfilled most of the deliverables defined in our agreement with the Knight Foundation, which ends in January 2015. Our remaining tasks are listed in the Issues section of this repo.
Please note that between now and January 2015, there could be breaking changes in the API as we update it to support the OpenReferral spec. The spec is currently at version 0.8, and version 1.0 is scheduled to be released by late January 2015.
- Ruby version 2.1.5
- Rails version 4.1.8
- Testing Frameworks: RSpec, Factory Girl, Capybara
Follow the instructions in INSTALL.md to get the app up and running, and to learn how to import your data.
You can see a running version of the different parts of the application here:
API documentation (work in progress)
As the API is updated to match the OpenReferral specification, the documentation will be updated as well. Version 1.0 of the spec is scheduled to be released by the end of January 2015.
- Ruby: Ohanakapa (our official wrapper)
We would love to see libraries for other programming languages. If you've built one, let us know and we'll add it here.
Out of the box, this project supports the Open Eligibility taxonomy. If you would like to use your own taxonomy, or add more categories to the Open Eligibility taxonomy, read our Wiki article on taxonomy basics.
Deploying to Heroku
See the Wiki.
Running the tests
Run tests locally with this simple command:
To see the actual tests, browse through the spec directory.
We'd love to get your help developing this project! Take a look at the Contribution Document to see how you can make a difference.
Copyright (c) 2013 Code for America. See LICENSE for details.