/jokegen-cli-app

Primary LanguageHTMLMIT LicenseMIT

JokeGenerator

Description

This is a CLI gem app that scrapes the comedy central joke database (jokes.cc.com). The CLI allows the user to choose an option to tell a random joke, or secondarily, select a joke from the database via a category.

Installation

After cloning the folder, and moving into the directory path, run 'bundle install' and then 'ruby bin/joke_generator' in the command line to get started.

Usage

Choose the first option for a random joke from the database. Choose the second option for a list of categories, which will lead to a list of joke titles. Then, choose a joke title to display the joke.

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/pcherian10/joke_generator. 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 JokeGenerator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.