This is a simple starting point for creating a new rails backend service. It includes:

• A Dockerfile for building a container
• A docker-compose.yml file for setting up a development environment
  • PostgreSQL
  • Redis
• Stripped-down rails base
  • No views
  • No asset pipeline
  • No cookie, session or flash middleware
  • Unity middleware
  • RSpec
  • Puma
  • RuboCop configuration
  • Reek configuration
  • New Relic configuration

{{ Project Name }}

{{ Project overview }}

API

{{ Public API documentation }}

Deployment

{{ Deploy requirements }}

Environment variables

• DB_NAME
• DB_USER
• DB_PASSWORD
• DB_HOST
• REDIS_URL
• NEW_RELIC_APP_NAME
• NEW_RELIC_LICENSE_KEY
• SENTRY_DSN
• SENTRY_SERVICE
• SENTRY_ENVIRONMENT
• WEB_CONCURRENCY number of puma workers
• MAX_THREADS number of threads per worker
• PORT default: 3000
• SECRET_KEY_BASE

Development

You need docker and docker-compose. To install them on OSX run:

brew install boot2docker docker docker-compose

The included docker-compose.yml file describes all containers needed to run the application in development. The bin/docker-run script wraps docker-compose, rebuilding the container on each run. To run the whole application:

./bin/docker-run

To run the tests:

./bin/docker-run rspec

To run a shell inside the container:

./bin/docker-run bash

Style guidelines

Try to follow the ruby community style guide, and keep your code clean. To check your code for issues, run:

./bin/lint

Or:

./bin/docker-run bin/lint