givegivegave

The word "give" should make you think of a charity database.

This is Ruby on Rails (Ruby 2.6, Rails 5.2.3) on Heroku. See https://devcenter.heroku.com/articles/getting-started-with-rails5 regarding running bundle install, bundle exec rake db:drop db:create, bundle exec rake db:migrate, bundle exec rails server, git push heroku my_topic_branch:master, etc.

For seeing your heroku logs you might like to install the free papertrail add-on. You can use the CLI to see your logs with heroku addons:open papertrail.

If you are on OS X you can use homebrew and rbenv to install ruby.

TODOs: What Needs Doing

See the github issue tracker. There's something to do no matter your skill level or commitment level. Learn all the tools the pros use while you pave the way for some world-changing applications!

Git Workflow

Fork this repo, make your change on a topic branch (a.k.a. feature branch), and submit a pull request against this repo to get a code review started.

git checkout -b do_something
edits...
git commit -a -m 'did something'
git push origin do_something
create a pull request on givegivegave repo against your new branch

Authentication and Authorization

We use devise for authentication and cancancan for authorization. Our user model is User. devise is very configurable. We have some of its views (HTML, email) here ready to be customized.

To send confirmation and reset emails, etc:

Sign up for a Sendgrid account (it's a heroku add-on if you want to do it that way) and get an API key and set it via heroku config:set SENDGRID_API_KEY=blah. Try resetting your password and you should see the email. You may want to disable "Click Tracking" so the link is to your host and not *.ct.sendgrid.net.

Even if you don't use Sendgrid for email, you must set the environment variable ACTION_MAILER_HOST to your hostname (example.com, e.g.) with heroku config:set.

Superusers a.k.a. Admins

We use rails_admin to manage things, so you can use it to edit Users to give the 'admin' attribute to a user. But you need your first superuser. For that,

Use bundle exec rails c locally or heroku run bundle exec rails c:

User.find_by(email: blah).update_attributes!(admin: true)

Admin Interface

You can use the /admin URL to manage database objects and users if you are a superuser.

Debugging the Database

Using psql:

username=# \l
\l
      List of databases
       Name           |   Owner   | Encoding |   Collate   |    Ctype    |   Access privileges   
--------------------------+-----------+----------+-------------+-------------+-----------------------
 givegivegave_development | username | UTF8     | en_US.UTF-8 | en_US.UTF-8 | 
 givegivegave_test        | username | UTF8     | en_US.UTF-8 | en_US.UTF-8 | 

username=# \c givegivegave_development
\c givegivegave_development
psql (10.1, server 10.3)
You are now connected to database "givegivegave_development" as user "username".
givegivegave_development=# \dt
\dt
     List of relations
 Schema |         Name         | Type  |   Owner   
--------+----------------------+-------+-----------
 public | ar_internal_metadata | table | username
 public | charities            | table | username
 public | schema_migrations    | table | username
 public | users                | table | username
(4 rows)

givegivegave_development=# select * from users;

Running Tests

We use VCR to record all HTTP interactions so that you can run unittests without an internet connection.

Changing some code? Delete all the relevant cassette YAML files (.yml) and run the tests.

Run the rspec test suite with bundle exec rspec

You must run postgres; see https://devcenter.heroku.com/articles/getting-started-with-rails5 regarding installing it.

Before tests will work you must create the test database with the following:

bundle exec rake db:create db:migrate

Note that we use Travis CI via .travis.yml.

Seeding the database

bundle exec rake db:seed will create an admin user and several charities. You need to get a CharityNavigator API key ("app key") first and set a couple of environment variables (keep these secret!).

If you run bundle exec rails server afterwards you should be able to login as admin@givegivegave.org with password adminadmin and the homepage will link you to rails_admin.

Algolia Search

Look at config/initializers/algoliasearch.rb to see how to set your credentials for Algolia if you want a search index for all your charities. You can use javascript APIs to search using only your frontend.

TODO(chandler37): Integrate backend search into GET /api/v1/charities?search=red+cross

See https://github.com/algolia/algoliasearch-rails

Security Updates

You should subscribe to the security announcement mailing lists (or, if there is none, the general announcement mailing list) for all third party libraries. Github itself does some limited security vulnerability tracking for owners of repositories by monitoring Gemfile.lock.

When you find a vulnerability, upgrade the affected gem using bundle update after removing any version contraint in Gemfile that pins to a vulnerable version.

chandler37/givegivegave