Gocongress

Licence

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contribute

Set up your local development environment
1. fork the repo in github
2. clone your fork locally
3. install the ruby version specified in the .rbenv-version
4. install postgres 9.1+
  - get the dev libs too (in apt-get that would be libpq-dev).
  - you'll want the dev libs to compile the pg gem
5. practice connecting to postgres
6. use the command-line client, psql
  - "permission denied"
  - Client Connection Problems
7. make sure you have an account that can create tables
8. install a js runtime, like node (apt-get nodejs)
  - macs come with a js runtime already installed
9. gem install bundler
10. bundle install
11. if all's well, bundle exec rake -T should give you a nice list of rake tasks
Run the tests
1. bundle exec rake db:setup db:test:prepare
2. bundle exec rake will run all specs and tests. if they all pass, you're good to go
Submit your contribution
1. Check that all the tests pass
2. Push your changes to your fork on github
3. Submit a pull request

Secrets

ENV variables are stored in a .env file, which is git-ignored. Some of these don't belong in source control because they are secret, and some vary by deployment level.

AUTHNET_API_LOGIN_ID='foo'
AUTHNET_RELAY_HOST='bar'
AUTHNET_TRANSACTION_KEY='baz'
GMAIL_SMTP_PASSWORD='herp'
GMAIL_SMTP_USER='derp'

This file will be loaded by config/initializers/dev_env.rb.

For local development, I wish we could use foreman to load .env, but it doesn't work with pry or guard and it's overkill for one process.

For stage and production use heroku config.

Email for gocongress.org

Email for accounts in the gocongress.org domain is managed through google apps. jared.beck@usgo.org has access to manage these accounts.

Thanks

Special thanks to Lisa Scott, who helped invent, and tirelessly tested, the first year's site in 2011.

2013: Chris Kirschner
2012: Arlene Bridges, Bob Bacon, Steve Colburn
2011: Lisa Scott, Alf Mikula, Brian David, Andrew Jackson, Steve Colburn

amj / gocongress