The open source API directory of community social services.
Ruby HTML PLpgSQL CSS JavaScript Shell CoffeeScript
Latest commit a918a61 Feb 11, 2017 @monfresh monfresh committed with monfresh Use latest Rubygems in Travis
**Why**: There is a bug in Rubygems < 2.6.9 that prevents the rainbos gem from being installed. See: sickill/rainbow#44
Permalink
Failed to load latest commit information.
app Update rubocop & haml_lint and fix offenses (#402) Nov 5, 2016
bin Add Docker support (#383) Jun 26, 2016
config Update Rubocop config and fix offenses (#394) Aug 14, 2016
data Update sample csv files Jun 22, 2015
db Update Rubocop config and fix offenses (#394) Aug 14, 2016
lib Update rubocop & haml_lint and fix offenses (#402) Nov 5, 2016
public Upgrade Rails from 3.2.17 to 4.0.4 Apr 10, 2014
script Bug fix (#390) Aug 13, 2016
spec Update rubocop & haml_lint and fix offenses (#402) Nov 5, 2016
vendor Create basic Rails app template May 29, 2013
.bummr-build.sh Add bummr gem to automate gem updates Jun 8, 2016
.codeclimate.yml Add Reek to Gemfile and Code Climate config (#398) Aug 14, 2016
.coveralls.yml Add coveralls and travis-ci yml files May 30, 2013
.dockerignore Add Docker support (#383) Jun 26, 2016
.gitattributes Add .gitattributes to enforce LF line endings. Dec 10, 2014
.gitignore Localize CSV-related buttons and notices. May 26, 2015
.haml-lint.yml Update haml-lint to version 0.7.0 & fix offenses. Nov 10, 2014
.hound.yml Add Hound config and fix offenses. Apr 5, 2015
.reek Add Reek to Gemfile and Code Climate config (#398) Aug 14, 2016
.rspec Localize CSV-related buttons and notices. May 26, 2015
.rubocop.yml Update rubocop & haml_lint and fix offenses (#402) Nov 5, 2016
.ruby-gemset Create basic Rails app template May 29, 2013
.ruby-version Update Ruby to 2.3.3 (#407) Dec 3, 2016
.scss-lint.yml Clean up CSS (#387) Jun 27, 2016
.travis.yml Use latest Rubygems in Travis Feb 11, 2017
CHANGELOG.md Update changelog for v1.2.0 Feb 8, 2016
CONTRIBUTING.md Update DB setup scripts and documentation. Oct 29, 2014
Dockerfile Add Docker support (#383) Jun 26, 2016
Gemfile Update Ruby to 2.3.3 (#407) Dec 3, 2016
Gemfile.lock Update webmock from 2.1.0 to 2.3.2 Feb 11, 2017
INSTALL.md Add Docker support (#383) Jun 26, 2016
LICENSE.md Update Readme and License May 14, 2013
Procfile Switch to puma per Heroku's recommendation. Mar 16, 2015
README.md Remove link to ohanapi.org from README (#408) Dec 21, 2016
Rakefile Update Rails to 4.1.1 Jun 26, 2014
VERSION Add VERSION file Apr 26, 2015
categories-in-ohana-api-admin.png Update README with useful info Feb 11, 2014
config.ru Update Rails to version 4.2.1 Mar 29, 2015
docker-compose.yml Add Docker support (#383) Jun 26, 2016

README.md

Ohana API

Build Status Coverage Status Dependency Status Code Climate security

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 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.

Apps built on top of Ohana API include a web-based search interface and an SMS app that allow anyone to easily find services that are available in a particular community.

Stack Overview

  • Ruby version 2.3.3
  • Rails version 4.2.7.1
  • 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

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

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.