/muhv

CLI generator to help developers to get started with services, function, lambda projects

Primary LanguageRuby

Muhv

A little small fluffy helper to make easier to get started with new projects;

Installation

  1. install thor
gem install thor
  1. clone the repo
git clone git@github.com:timgluz/muhv.git
  1. install the gem version
bin/setup

Dev version

clone the repo and code is executable like this:

./bin/muhv

# old version without Zeitwerk
RUBYLIB=lib/ ./bin/muhv

Usage

Generate project for Ruby' Dry lambda

$> muhv drylambda xample

Result:

.
├── .editorconfig
├── .gitignore
├── .overcommit.yml
├── .rubocop.yml
├── .ruby-gemset
├── .ruby-version
├── Gemfile
├── Gemfile.lock
├── Makefile
├── README.md
├── app
│   ├── functions
│   │   ├── base_dry_function.rb
│   │   └── health.rb
│   ├── functions.rb
│   ├── lib
│   │   └── hash.rb
│   ├── services
│   │   └── base_dry_service.rb
│   └── services.rb
├── handlers.rb
├── loader.rb
├── serverless.yml
└── spec
    ├── functions
    │   └── health_spec.rb
    └── spec_helper.rb

6 directories, 23 files

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/timgluz/muhv.