KamalUi

KamalUi is a Rails engine for easily configuring deployment settings in Rails applications. It provides a simple web interface to edit the deploy.yml file, streamlining the deployment process.

Install the gem and add to the application's Gemfile by executing:

bundle add kamal_ui

or simply add it to the Gemfile:

gem 'kamal_ui'

Then execute:

bundle install

Or install it yourself as:

gem install kamal_ui

Mount the KamalUi engine in your application's config/routes.rb:

mount KamalUi::Engine, at: '/kamal_ui'

Access the deployment configuration interface at /kamal_ui/deploy (e.g. http://localhost:3000/kamal_ui/deploy).

Ensure your application has a deploy.yml file in a known location. Configure the path in the KamalUi settings if it differs from the default.

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 the created tag, and push the .gem file to rubygems.org.

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

The gem is available as open source under the terms of the MIT License.

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