https://github.com/patrick-rush/brewery_cli
Baby's first project! This simple Brewery CLI tool lets you look up breweries, perhaps while you're planning your next excursion to another city! This was my very first project at Flatiron School.
https://github.com/patrick-rush/brewery_cli
breweries cli flatiron-school-project ruby
Last synced: 8 months ago
JSON representation
Baby's first project! This simple Brewery CLI tool lets you look up breweries, perhaps while you're planning your next excursion to another city! This was my very first project at Flatiron School.
- Host: GitHub
- URL: https://github.com/patrick-rush/brewery_cli
- Owner: patrick-rush
- License: mit
- Created: 2020-07-03T01:06:11.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-08T20:31:31.000Z (almost 6 years ago)
- Last Synced: 2025-01-12T10:47:50.112Z (over 1 year ago)
- Topics: breweries, cli, flatiron-school-project, ruby
- Language: Ruby
- Homepage: https://youtu.be/W4f_5OkBl00
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# BreweryCli
Welcome! This Brewery CLI program allows you to search breweries in the United States using a zip code, the name of a city, or the name of a state. Additionally, you can look up information such as the address and phone number for any breweries you find. I hope you enjoy using it and find it helpful!
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'brewery_cli'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install brewery_cli
## Usage
Run `bin/setup` to install dependencies. To run the program, run `bin/brewery_cli` and follow the prompts.
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com//brewery_cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com//brewery_cli/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the BreweryCli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com//brewery_cli/blob/master/CODE_OF_CONDUCT.md).