hopegipson / Dueling_Defenders

A CLI application built in Ruby that allows users to battle superheroes! Pick your favorite hero and favorite anti-hero and see if you can hold up in battle.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Dueling Defenders

GitHub code size in bytes GitHub language count GitHub top language GitHub contributors GitHub issues GitHub last commit GitHub forks GitHub Repo stars YouTube Video Views YouTube Video Likes

This CLI accesses data from this API and allows users to learn more about superheroes, while also battling superheroes and deciding the victor based on key attributes. The user can decide between 5 options (and exit). The first option is learning more about a superhero, that the user will then input. The second option is assigning a superhero to the user, so that the user may battle as this superhero. The third option allows the user to learn about the superhero they are currently playing as at any time. The fourth option allows the user to battle. In battle, the user selects another superhero to try to defeat. The user can then choose if they are ready or not to battle. After the battle, the victor will be displayed based on who had better attributes in six categories: intelligence, strength, speed, durability, power, and combat. The fifth option allows the user to see a list of Superhero characters in the battleground, and how many wins and losses they have accumulated.

To watch a demo of the CLI:

Demo of Spotify app

Blog Post with Further Explanation on CLI build: Here

Installation

Add this line to your application's Gemfile:

gem 'Dueling_Defenders'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install Dueling_Defenders

Usage

Use bin/Dueling_Defenders to execute.

An API key is required to use this application, and is to be stored in an environmental variable before usage.

Access this API and sign up for a key/access-token, this key is free as of this release. Create a .env file and API_KEY=YOUR_API_KEY_HERE replace YOUR_API_KEY_HERE with the API key you retrieve from the superhero API.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake true 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 here. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

-Fork this repository.
-Create a branch: git checkout -b <branch_name>.
-Make your changes and commit them: git commit -m '<commit_message>'
-Push to the original branch: git push origin Spotify_Clone/master
-Create the pull request.

License

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

Code of Conduct

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

About

A CLI application built in Ruby that allows users to battle superheroes! Pick your favorite hero and favorite anti-hero and see if you can hold up in battle.

License:MIT License


Languages

Language:Ruby 99.3%Language:Shell 0.7%