Find a Cocktail is a CLI for interacting with the TheCocktailDB API. It searches for cocktails by name and returns information including recipes, cocktail image links and preparation video links.
Add this line to your application's Gemfile:
gem 'find_a_cocktail'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install find_a_cocktail
Upon running the CLI, type the name of a cocktail to initiate a search. The CLI will return a list of matching cocktails in a numbered list, from which you can choose using its relevant list number in order to display more information on that cocktail. The CLI will then display the cocktail's recipe, it's ingredients and their measurements, and display three options. Access a video of the preparation of the cocktail by typing "show me", or an image of the finished cocktail by typing "finished". Otherwise type "search" to initiate a new cocktail search, or "exit" to quit the application.
After checking out the repo, run bin/setup
to install dependencies. 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.
Bug reports and pull requests are welcome on GitHub at https://github.com/VirgilCantu/find_a_cocktail. 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 FindACocktail project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.