https://github.com/rmcfadzean/rails-docker-template

A Rails bootstraping template including Docker
https://github.com/rmcfadzean/rails-docker-template

docker docker-compose rails rails-docker rails-template ruby-on-rails

Last synced: 3 months ago
JSON representation

A Rails bootstraping template including Docker

• Host: GitHub
• URL: https://github.com/rmcfadzean/rails-docker-template
• Owner: rmcfadzean
• License: mit
• Created: 2017-01-22T14:04:18.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-03-10T02:19:57.000Z (over 8 years ago)
• Last Synced: 2025-01-27T23:31:58.406Z (over 1 year ago)
• Topics: docker, docker-compose, rails, rails-docker, rails-template, ruby-on-rails
• Language: Ruby
• Size: 18.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Rails Docker Template [WIP]

A Rails template for generating a clean, new Rails (API) project with Docker, docker-compose, rspec and some nice defaults.

## Notes / Requirements

* This is **very** opinionated.

* Rails >= 5.0.0

* Ruby 2.5.0

* `--api` only

## Usage

### Installation

```sh

rails new my_unicorn \

  -d postgresql \

  --api \

  -m https://raw.githubusercontent.com/rmcfadzean/rails-docker-template/master/template.rb

```

### Using the application

#### Development

`docker-compose run web rails db:create`

#### Testing

`docker-compose run web rspec`

#### Deploying

TODO

## The opinions

* Testing is done with Rspec & Rack::Test

  * Controller tests are [out](https://github.com/rails/rails/issues/18950#issuecomment-77924771)

  * Integration/request/API tests are in

* Docker & Docker compose are used for a containerised application

### Gem List

* Core

  * rails 5.1.5

  * ruby 2.5.0

  * postgres

  * puma

  * rack-cors - [Cross-origin resource sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)

  * [health_check](https://github.com/ianheggie/health_check) - Creates a `_health` canary endpoint.

  * jbuilder

* Testing

  * rspec-rails

  * webmock - Stop hitting real endpoints! You're testing your application, not theirs.

  * factory_girl_rails - Boo fixtures. Yay factories!

  * timecop - Allows you to timetravel during your tests

  * simplecov - Test coverage checker

  * [faker](https://github.com/stympy/faker) - Generating fake data

* Debugging

  * awesome_print - `ap @object` will print out things in a nice way to help with puts debugging

  * pry-rails - `binding.pry` will save your life

  * bullet - Helps with finding N+1 queries

  * [sentry](https://sentry.io) - catch and log your errors.

* Security & Style

  * rubocop - A style checker with an autofixer. Keep your code clean and readable!

  * brakeman - Static analysis for security vulns & bad practice.

  * bundler-audit - Checks your gemfile for known vulnerabilities

* Utils

  * annotate - Annotates your models, routes and factories with schema comments. Helpful for at-a-glance checks.

## Credits

* [Suspenders](https://github.com/thoughtbot/suspenders/)

* [jkxyz/rails-docker-template](https://github.com/jkxyz/rails-docker-template)

* [mattbrictson/rails-template](https://github.com/mattbrictson/rails-template)

## License

MIT