• Search results are aided by a thesaurus service provided by words.bighugelabs.com.
• Background photo courtesy of Royal Realty

If you are using OS X Snow Leopard, Lion or Mountain Lion, please follow this guide which will take you through the setup procedure

Mac OS X is best supported by Honolulu Answers, since it is what most of us at Code for America use. Ubuntu (and therefore presumeably other linux distributions) are also supported. Windows is currently unsupported and untested.

Installation Instructions for OS X 10.8 Mountain Lion

Slightly outdated Ubuntu instructions are available here.

$ foreman start

$ heroku create honoluluanswers --stack cedar
$ git push heroku master
$ heroku config push
$ heroku config set LD_LIBRARY_PATH='lib/native'
$ heroku addons:add searchify:small # WARNING: paid addon!
$ heroku addons:add memcache
$ heroku addons:add newrelic:standard
$ heroku run rake db:setup

foreman run bundle exec rake spec command will run the current tests, these test need to be expanded.

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

• by using alpha, beta, and prerelease versions
• by reporting bugs
• by suggesting new features
• by translating to a new language
• by writing or editing documentation
• by writing specifications
• by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
• by refactoring code
• by closing issues
• by reviewing patches
• financially

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

1. Fork the project.
2. Create a topic branch.
3. Implement your feature or bug fix.
4. Add tests for your feature or bug fix.
5. Run bundle exec rake test. If your changes are not 100% covered, go back to step 4.
6. Commit and push your changes.
7. Submit a pull request. Please do not include changes to the gemspec or version file. (If you want to create your own version for some reason, please do so in a separate commit.)

• Support other search indexes backends/services (perhaps just fulltext search in DB as a fallback)
• A comprehensive admin component
• Results tailored to current location

This library aims to support and is [tested against][travis] the following Ruby implementations:

• Ruby 1.9.3

If something doesn't work on one of these interpreters, it should be considered a bug.

This library may inadvertently work (or seem to work) on other Ruby implementations, however support will only be provided for the versions listed above.

If you would like this library to support another Ruby version, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be personally responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.

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