/cli-gem-portfolio-project

Procedural and Object-Oriented Ruby-based CLI with detail-oriented, user-friendly design

Primary LanguageRubyMIT LicenseMIT

HoustonDogAdoption

This gem helps users who are looking to adopt a dog in Houston, Texas identify the perfect dog for them. It utilizes website data on adoptable dogs being housed by the Houston Humane Society to guide the user through the selection process.

Installation

Add this line to your application's Gemfile:

gem 'houston_dog_adoption'

And then execute:

$ bundle

Or install it yourself as:

$ gem install houston_dog_adoption

Usage

Launch program by typing:

./bin/houston-dog-adoption

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. 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//houston_dog_adoption. 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.

Code of Conduct

Everyone interacting in the HoustonDogAdoption project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com//houston_dog_adoption/blob/master/CODE_OF_CONDUCT.md).

Blog & Video

Read about what I learned while building this project!

Click below to check out a demo!
Check out a demo of my app