Skip to content
A CLI Ruby application for finding the best burgers in the Baltimore area
HTML Ruby Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
fixtures
lib
ref
.gitignore
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
Gemfile.lock
LICENSE.txt
README.md Adds details into restaurant object to todo list Aug 15, 2019
Rakefile
burger_finder.gemspec

README.md

Burger Finder

A CLI application to help you find the best burger joints in the Baltimore area. Yum!

🍔🍔🍔🍔🍔

About

I like burgers. And I like to know where the best ones are in my area at all times. So, I build an application to do that.

My blog post CLI Have No Idea What I’m Doing: Planning (and Building) My First CLI Application goes into detail on the steps I took to make this happen.


Installation

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/burger_finder. To experiment with that code, run bin/console for an interactive prompt.

Add this line to your application's Gemfile:

gem 'burger_finder'

And then execute:

$ bundle

Or install it yourself as:

$ gem install burger_finder

Usage

To start the program run:

ruby bin/start

Or

./bin/start

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 burger_finder. 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 are welcome on GitHub at https://github.com/scrabill/burger_finder. 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.

To Do

  • Implement an API for restaurant data
  • Display data based on user input for location (city or zip code)
  • Better logic for edge cases (invalid input, etc)
  • Error handling
  • Save restaurant details into object after first call

License

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

Code of Conduct

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

You can’t perform that action at this time.