Welcome to the Restaurant CLI Gem! This gem allows the ability to search through a given list of restaurants in the NYC boroughs and return data about the type of restaurant, grade rating, and violation description.
To use on your local machine, please do the following:
Go to https://github.com/melchr/restaurant_data_project
Under the repository name, click Clone or download.
Select whether you'd like to clone with an SSH key or URL, and press the clipboard icon to copy it.
git@github.com:melchr/restaurant_data_project.git
Next, open your Terminal.
Change the current working directory to the location where you want the cloned directory to be made.
cd restaurant_data_project
Type git clone, and then paste the URL you copied.
$ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY
Press Enter. Your local clone will be created.
Then, install dependencies by typing:
bundle install
To make a pull request, please go to: https://github.com/melchr/restaurant_data_project/compare
(For troubleshooting help, go to https://help.github.com/en/articles/troubleshooting-connectivity-problems)
To start the Restaurant Data Project, change directories to where the github clone is located.
cd YOUR-FOLDER
cd restaurant_data_project
Type the following to start the program:
bin/restaurant_cli
This will immediately prompt you and guide you through the app.
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/melchr/restaurant_data_project/issues. 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.
Restaurant Data Project License
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the RestaurantDataProject project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.