Rails API Template

A base template to get started with a Rails 5 API. Includes the following:

• A rails web server and Postgres database container using docker-compose
• A .ruby-version file for rvm
• A .ruby-gemset file to namespace dependencies

Provided dependencies

The following dependencies are installed by default:

• rails
• pg
• rspec
• rspec-rails
• shoulda matchers
• rubocop

Docker containers

A docker-compose.yml file is included which contains:

• A rails webserver for development, named webserver
• A postgresql database, named database

To start the containers, run docker-compose up which will build the webserver container and link it to the database.

Both containers are configured using environment files located in the env directory. The database container uses the database.env file, and webserver uses both database.env and web.env.

database.env contains:

• The user which should own the database (default: postgres)
• The user's password (default: mysecretpassword)
• The name of the database (default: rails_db)

web.env contains:

• The name of the database host to connect to (default: db)
• The port on which postgresql accepts incoming connections (default: 5432)