forked from codeforamerica/honolulu_answers
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md~
176 lines (117 loc) · 6.39 KB
/
README.md~
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# Honolulu Answers
*Honolulu Answers* is...
## Installation
**You need bundler 1.2 or higher in order to successfully run `bundle install`**
$ bundle install
# Fill in `config/dblogin.yml`
$ rake db:create
$ rake db:schema:load
To setup some example data:
$ rake db:seed
### Dependencies
`bundle install` will likely fail as some of the gems require native libraries to be installed on your system. The following gems require libraries which are not included on Ubuntu 12.04 by default:
* Ruby >= 1.9 compiled with `psych`, `readline`, `zlib` and `openssl`
* nokogiri
* `sudo apt-get install libxslt1-dev libxml2-dev`
* capybara-webkit
* `sudo apt-get install libqt4-dev libqtwebkit-dev g++`
* pg
* `sudo apt-get install libpq-dev`
* sqlite3
* `sudo apt-get install sqlite3 libsqlite3-dev`
One-liner for the brave:
sudo apt-get install libxslt1-dev libxml2-dev libqt4-dev libqtwebkit-dev g++ libpq-dev sqlite3 libsqlite3-dev
## Configuration
### Setting up Searchify
We use the [Searchify](https://addons.heroku.com/searchify) heroku addon to power the search index for honolulu answers. In order to use this in development you can either run a copy of Indextank (which is what Searchify is built on) or add the searchify addon to a heroku app, and copy the provided search api endpoint to your .env file.
Since Searchify only offer paid plans, for development you might want to check out the following free IndexTank providors and use the API key they supply: (1) [HoundSleuth](houndsleuth) (2) [IndexDen](indexden)
[houndsleuth]: http://www.houndsleuth.com/
[indexden]: http://indexden.com/
### Setting up BigHugeThesaurus
We use [Big Huge Thesaurus](bht) in order to enhance search queries. In order to run this in development you will need an API key, freely available at [bht.com](bht).
[bht]: http://www..com
### Environment Vars
Honolulu Answers uses Environment variables for configuration. It expects a `BHT_API_KEY`, and `SEARCHIFY_API_URL` to be set to the searchify endpoint (which can be retrived from `heroku config` once searchify is an addon for your app)
`foreman` is a great tool for checking your Procfile used for heroku, and running your application locally. When running `foreman start` this will load enivronment variables from `.env` if that file is found.
Included in this project is an example of what the `.env` file should include. In order to use this make a copy and replace the values appropriate values for your setup.
$ cp .env.sample .env
Now edit `.env` to set the correct url to the searchify endpoint.
### DB Login
Also included `config/dblogin.yml.sample` copy this file too
$ cp config/dblogin.yml.sample config/dblogin.yml
Now if you need to set login credentials for your database that that are different then the default, you can do it in `config/dblogin.yml`
Both `config/dblogin.yml` and `.env` are added to the `.gitignore` so changes should not be committed, dont commit passwords :)
## Usage
$ rails s
With Foreman (used to load .env):
$ foreman start
## Deploying to Heroku
$ heroku create honoluluanswers --stack cedar
$ git push heroku master
$ heroku run rake db:schema:load
$ heroku addons:add searchify:small
## Testing
`bundle exec rspec spec/` command will run the current tests, these test need to be expanded.
## Contributing
In the spirit of [free software][free-sw], **everyone** is encouraged to help
improve this project.
[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
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][]
[issues]: https://github.com/codeforamerica/honolulu_answers/issues
[financially]: https://secure.codeforamerica.org/page/contribute
## Submitting an Issue
We use the [GitHub issue tracker][issues] 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.
[gist]: https://gist.github.com/
## Submitting a Pull Request
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.)
## Roadmap
* Support other search indexes backends/services (perhaps just fulltext search in DB as a fallback)
* A comprehensive admin component
* Results tailored to current location
## Supported Ruby Versions
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
Copyright (c) 2012 Code for America. See [LICENSE][] for details.
[license]: https://github.com/codeforamerica/cfa_template/blob/master/LICENSE.mkd
[][tracker]
[tracker]: http://stats.codeforamerica.org/projects/honolulu_answers