Skip to content

README.md

Latest commit

 

History

History
36 lines (22 loc) · 963 Bytes

README.md

File metadata and controls

36 lines (22 loc) · 963 Bytes

ruby-starter

Boilerplate code for starting a ruby project with docker / docker-compose

Set up

Run the setup script

./init.sh

This will:

  • copy env.example to .env
  • enable the precommit hook which wil lint the code before committing. Uncomment those lines in .git/hooks/precommit to enable running tests.
  • build the docker image
  • install the gems

The script does not overwrite .env or /git/hooks/precommit.

Tests

This has rspec initialialized and has one sample test in spec/sample_spec.rb.

A github actions workflow is included that runs standard linting and the tests

Profiler

To run the profiler middleware, set the "PROFILE_ON" environment variable to something. This will cause profile reports to be generated per endpoint in tmp/profile

Background

This repository goes with this documentation: https://mlit.atlassian.net/wiki/spaces/LD/pages/2404090314/Getting+Started+with+Docker+and+Docker-Compose