j0narch3r / pay-it-forward

Gamified, viral fundraising for charities.

Pay it Forward

Built With

Open Source:

• Ruby on Rails
• PostgreSQL
• Redis
• jQuery
• Bootstrap

Services:

• Heroku
• S3

Setup

Setup Backing Resources

• Setup Postgres
• Setup Redis
• Run ./bin/setup
  • If you run into any error, configure the .env file and retry.

Setup Backing Resources With Docker

Note: Since this project is setup to deploy via Heroku and their buildpacks, a rails/web docker container is not available. Having a web container would provide no benefit the development workflow at this time.

• Install Docker
• Initialize Boot2Docker boot2docker init
• Install Fig
• Start Boot2Docker boot2docker up
  • Note: It's recommended to add the exports to your ~/.bash_profile then reload your prompt
• Start Backing Services source docker.sh
• Run ./bin/setup

Environment Variables

• All

  • DATABASE_URL: postgresql://username:password@host:port/database
  • REDIS_URL: redis://username:password@hostname:port/database_number

• Development

  • TRUSTED_IP: 172.17.42.1 (Better Errors: Optional)

• Production

  • APP_HOST: example.com

  • SECRET_KEY_BASE: ea1e8ba83614cc8d6140105a42642dc8391d6f2f8...

  • Twitter

    • TWITTER_KEY: lkfAc16oTJcbR766zw8GDw...
    • TWITTER_SECRET: NT7WOYKnZplMYQeJ8GjeXHup9sPk5WbR1WZFritdnARP5x7...

  • Facebook

    • FACEBOOK_KEY: 559887567744...
    • FACEBOOK_SECRET: 445a594f443e2f1bcd3025f99e693...

  • AWS

    • AWS_ACCESS_KEY_ID: AKIAIOSFODNN7EXAM...
    • AWS_SECRET_ACCESS_KEY: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLE...
    • AWS_S3_REGION: us-east-1
    • AWS_S3_BUCKET: name
    • AWS_S3_FQDN: //localhost
    • ASSETS_DIRECTORY: /development/assets

  • Stripe

    • STRIPE_KEY: pk_test_4TYeurr4kT16D6KedSAlT...
    • STRIPE_SECRET: sk_test_4TYeUPbdKFGeJUXBVJFoI...

Contributing

This project's git flow is based on A successful Git branching model

1. Find or Submit Bounty
2. Make a Feature Branch from develop

• Name it based on bounty: 18-init-project

3. Make Changes

• Use micro commits
• Use the imperative, present tense: "change", not "changed" or "changes".

4. Write tests

• Will not accept PRs that reduce coverage

5. Open PR back into develop

• Make PR Description links to the Bounty and add a comment to the Bounty linking the PR
• Add accompanying images for UI changes