Skip to content

Quickly browse BGG's hot 50 boardgames list without leaving your terminal.

License

Notifications You must be signed in to change notification settings

imjoshellis/BGG-Hotness-CLI

Repository files navigation

BGG Hotness CLI

Description

BGG Hotness CLI is a fast command line interface for checking the top 50 hot boardgames of BoardGameGeek.com's API.

It was built by @imjoshellis as a part of Flatiron School's Software Engineering program.

Watch Demo Video Here

Installation

Add this line to your application's Gemfile:

gem "bgg-hotness-cli"

And then execute:

bundle

Or if you prefer:

gem install bgg-hotness-cli

Usage

Run bin/bgg-hotness-cli in your terminal for a quickstart.

Or require 'bgg-hotness-cli and create run with BggHotnessCLI::CLI.run.

For example:

irb
require 'bgg-hotness-cli'
BggHotnessCLI::CLI.run

Once you're in the interface, use ↑/↓ arrows to navigate between options and press Enter to select your choice.

screenshot of start page

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/imjoshellis/bgg-hotness-cli 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 Bgg Hotness CLI project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.