⚡️ 😴 Miami's fork of the open source API directory of community social services.
Ruby HTML PLpgSQL CSS JavaScript Shell CoffeeScript
Clone or download
Pull request Compare This branch is 42 commits ahead, 488 commits behind codeforamerica:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
data
db
lib
public
script
spec
vendor
.coveralls.yml
.gitattributes
.gitignore
.haml-lint.yml
.rubocop.yml
.ruby-gemset
.travis.yml
CONTRIBUTING.md
Gemfile
Gemfile.lock
INSTALL.md
LICENSE.md
Procfile
README.md
Rakefile
categories-in-ohana-api-admin.png
config.ru

README.md

#Ohana API

Build Status Coverage Status Dependency Status Code Climate

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.

Stack Overview

  • Ruby version 2.1.5
  • Rails version 4.1.8
  • Postgres
  • Testing Frameworks: RSpec, Factory Girl, Capybara

Local Installation

Follow the instructions in INSTALL.md to get the app up and running, and to learn how to import your data.

Demo

You can see a running version of the different parts of the application here:

Developer portal: http://ohana-api-demo.herokuapp.com/ (see db/seeds.rb for two usernames and passwords you can sign in with).

API: http://ohana-api-demo.herokuapp.com/api

Admin Interface: http://ohana-api-demo.herokuapp.com/admin (see db/seeds.rb for three usernames and passwords you can sign in with).

API documentation (work in progress)

http://codeforamerica.github.io/ohana-api-docs/

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.

Client libraries

We would love to see libraries for other programming languages. If you've built one, let us know and we'll add it here.

Taxonomy

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:

script/test

To see the actual tests, browse through the spec directory.

Contributing

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

Copyright (c) 2013 Code for America. See LICENSE for details.