Set up docker-compose for Micropurchase Rails app

Skills

Description

We want setting up a development environment for the micro-purchase Rails app to be as easy as possible. To accomplish this, we want to use docker-compose. This issue seeks to make it easy for anyone to get up running with a local instance of the micro-purchase Rails app.

Auction rules

Registered users on micropurchase.18f.gov may bid to deliver the requirements in this auction. The lowest bidder at the time the auction closes shall receive the award. The awarded bidder shall have five business days to deliver the requirements. Upon successful completion of the requirements, 18F shall pay the winning bidder.

Also see our policies and guidelines page.

Acceptance Criteria

Given a clone of the 18F/micropurchase git repository

When the developer obtains and adds the appropriate GitHub API keys

And the developer runs docker-compose up

Then the developer has access to a complete development environment for the micro-purchase Rails app

To test acceptance, we're going to:

• Clone the https://github.com/18f/micropurchase and checkout the delivered Pull Request
• Edit the .env file (read this page for more information on how docker-compose handles environment variables)
• Run docker-compose up
• Visit the homepage on localhost (or similar)
• Click on the first auction listed (ensure that docker-compose up loads the data from db/seeds.rb)
• Login using GitHub OAuth.
• Run the test suite from within the Docker container (the command for this must be documented in the README.)

We'll accept the delivery if each of these steps is successful.

General acceptance criteria

• B or better Code Climate grade and 90% or higher test coverage for all modifications.
• Tests run on Travis-CI and do not break the build.
• New features do not degrade accessibility (use pa11y/HTML Code Sniffer).
• New functionality is adequately documented.

Resources

• https://github.com/18F/micropurchase
• https://docs.docker.com/compose/
• http://blog.carbonfive.com/2015/03/17/docker-rails-docker-compose-together-in-your-development-workflow/
• https://docs.docker.com/v1.8/compose/yml/#env-file

Deliverables

A single pull request submitted to https://github.com/18F/micropurchase with clear, descriptive commits that satisfy all of the above acceptance criteria.