Skip to content

Latest commit

 

History

History
55 lines (30 loc) · 1.92 KB

README.md

File metadata and controls

55 lines (30 loc) · 1.92 KB

Railsdock Logo

A command line tool for Dockerizing your Rails development environment.

Prerequisite

The configuration generated by this gem depends on Docker Desktop. Make sure it is installed before continuing.

Installation

Install the gem:

$ gem install railsdock

Or add it to your Gemfile:

gem 'railsdock', require: false, group: :development

Then run:

$ bundle

Usage

Navigate to your project directory:

$ cd /path/to/my/app

Then run:

$ railsdock install

The gem will then walk you through configuring Docker by asking questions about your environment.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hintmedia/railsdock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the Railsdock project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Copyright

Copyright (c) 2019 Hint. See MIT License for further details.