Skip to content

Latest commit

 

History

History
184 lines (140 loc) · 6.8 KB

README.md

File metadata and controls

184 lines (140 loc) · 6.8 KB
Raw

Adopt-a-Drain Lafayette

Claim responsibility for cleaning out a storm drain after it rains.

Screenshot

Adopt-a-Drain

Demo

You can see a running version of the application at https://adopt-a-drain.infascination.com/.

Installation (Host) - Local

This application requires Postgres to be installed

git clone git://github.com/sfbrigade/adopt-a-drain.git
cd adopt-a-drain
bundle install

bundle exec rake db:create
bundle exec rake db:schema:load

See the wiki for a guide on how to install this application on Windows.

Install (Docker) - Local

To setup a local development environment with Docker.

# Override database settings as the docker host:
echo DB_HOST=db > .env
echo DB_USER=postgres >> .env

# Setup your docker based postgres database:
docker-compose run --rm web bundle exec rake db:setup

# Load data:
#docker-compose run --rm web bundle exec rake data:load_drains
# OR: don't load all that data, and load the seed data:
docker-compose run --rm web bundle exec rake db:seed

# Start the web server:
docker-compose up

# Visit your website http://localhost (or the IP of your docker-machine)

Deploy on AWS

(US-EAST-1 Region Only)

This application is deployed using AWS CloudFormation.

Shared Resources - CloudFormation Parameters: (required)

  • DockerhubPassword
  • DockerhubUsername
  • RepositoryName
  • WorkshopName
  • GitHubRepo
  • GitHubBranch
  • GitHubToken (never commit this value)
  • GitHubUser
This solution require Shared Resource stack to be deployed as primary stack, then Applicaiton stack.

Application Resources - CloudFormation Parameters: (required)

  • RepositoryName
  • SharedResourceStack
  • InstanceType
  • SendgridPassword
  • CertificateARN
  • HostedZoneId
  • Domain
  • Subdomain
Order Stacks Deploy
1 Shared Resources Launch
2 Application Launch

AWS-CLI Deployment scenarios:

  • Local bash terminal
  • Cloud9 (us-east-1)

This application will be deployed on EC2 Autoscaling Group nodes working behind an Application Load Balancer. It can be used as an example application in a workshop, with multiple stacks in the same account.

Create shared resources:

aws cloudformation deploy --stack-name adopt-a-drain-shared --template-file cfn/shared-resources.yml --capabilities CAPABILITY_NAMED_IAM --parameter-overrides WorkshopName="adopt-a-drain"

Create ECS resources:

aws cloudformation deploy --stack-name adopt-a-drain-app --template-file cfn/application.yml --parameter-overrides SharedResourceStack="adopt-a-drain-shared"

Usage

rails server

Seed Data

bundle exec rake data:load_drains

Google Analytics

If you have a Google Analytics account you want to use to track visits to your deployment of this app, just set your ID and your domain name as environment variables:

heroku config:set GOOGLE_ANALYTICS_ID=your_id
heroku config:set GOOGLE_ANALYTICS_DOMAIN=your_domain_name

An example ID is UA-12345678-9, and an example domain is adoptadrain.org.

Contributing

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

Submitting an Issue

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. 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.

Submitting a Pull Request

  1. Fork the repository.
  2. Create a topic branch.
  3. Add specs for your unimplemented feature or bug fix.
  4. Run bundle exec rake test. If your specs pass, return to step 3.
  5. Implement your feature or bug fix.
  6. Run bundle exec rake test. If your specs fail, return to step 5.
  7. Run open coverage/index.html. If your changes are not completely covered by your tests, return to step 3.
  8. Add, commit, and push your changes.
  9. Submit a pull request.

Supported Ruby Version

This library aims to support and is [tested against][travis] Ruby version 2.2.2.

If something doesn't work on this version, 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 version 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) 2015 Code for Lafayette. See LICENSE.md for details.