zlehmann / nyc_beer

Flatiron CLI Project - a command line application built in Ruby that scrapes popular New York City Breweries for their latest beer lists.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NycBeer

Welcome to the NYC Beer Gem! This gem was developed as a Flatiron School project. I developed this gem to help users explore the breweries of New York City through a command line interface. This gem allows the user to view a list of every brewery in New York City and pull up beer lists for each brewery.

Installation

Add this line to your application's Gemfile:

gem 'nyc_beer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nyc_beer

Usage

Execute the bin file './bin/nyc_beer'. You will be prompted with a list of the breweries in New York City. You can enter the corresponding number for any brewery to pull up that brewery's beer list containing details about each beer.

Development

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/'zlehmann'/nyc_beer. 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.

License

The gem is available as open source under the terms of the MIT License. Copyright 2018 Zachary Lehmann

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Code of Conduct

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

About

Flatiron CLI Project - a command line application built in Ruby that scrapes popular New York City Breweries for their latest beer lists.

License:MIT License


Languages

Language:Ruby 97.8%Language:Shell 2.2%