Skip to content

smcgov/ohana-api-smc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CircleCI Maintainability Test Coverage View performance data on Skylight

Ohana API - San Mateo County

This is the API + Admin Interface portion for the San Mateo County instance of the Ohana API. The API exposes information about community resources in San Mateo County to make it easier for residents in need to find services they are eligible for.

Apps that are using the Ohana API in San Mateo County

SMC-Connect, a mobile-friendly website for looking up community and human services. (GitHub repo for SMC-Connect)

We encourage third-party developers to build additional applications on top of the API. You can register your app on our developer portal, and view the API documentation.

Taxonomy

We are currently using the Open Eligibility taxonomy to assign Services to Categories. The easiest way to assign categories to a service is to use the Admin interface. Here's a screenshot:

Editing categories in Ohana API Admin

API documentation

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

Client libraries

Ruby wrapper

https://github.com/codeforamerica/ohanakapa

Stack Overview

  • Ruby version 3.1.4
  • Rails version 6.1.7
  • Postgres version 14.5
  • Redis
  • Testing Frameworks: RSpec, Factory Girl, Capybara

Local Installation

Follow the instructions in INSTALL.md.

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.

About

API for community social services in San Mateo County, CA

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 84.6%
  • Haml 8.0%
  • PLpgSQL 4.8%
  • HTML 0.7%
  • SCSS 0.7%
  • JavaScript 0.6%
  • Other 0.6%