https://github.com/mlibrary/ruby-starter
Boilerplate code for developing a ruby app in docker
https://github.com/mlibrary/ruby-starter
Last synced: over 1 year ago
JSON representation
Boilerplate code for developing a ruby app in docker
- Host: GitHub
- URL: https://github.com/mlibrary/ruby-starter
- Owner: mlibrary
- License: other
- Created: 2020-11-12T19:38:11.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-03T22:11:51.000Z (over 1 year ago)
- Last Synced: 2025-02-03T22:32:52.757Z (over 1 year ago)
- Language: Ruby
- Size: 25.4 KB
- Stars: 1
- Watchers: 25
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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
## Background
This repository goes with this documentation:
https://mlit.atlassian.net/wiki/spaces/LD/pages/2404090314/Getting+Started+with+Docker+and+Docker-Compose