Welcome to the Hogwarts gem! This Ruby gem transports you to the Hogwarts School for Witchcraft and Wizardry. You will be sorted into a house and be able to learn more about the houses of Hogwarts and your fellow students.
Navigate to the repo on GitHub: https://github.com/LizLaffitte/hogwarts
Click the green Clone or Download button. Click the clipboard icon to copy the remote URL.
In terminal, type the command git clone, and then paste the copied URL:
git clone git@github.com:LizLaffitte/hogwarts.git
Use the cd command in the terminal to open the hogwarts directory
cd hogwarts
Install the dependencies by typing this command into the terminal:
bundle install
To run the Hogwarts CLI gem, type the following command:
./bin/run
You can now follow the prompts to be sorted into a house, and learn more about all of Hogwart's houses and your fellow classmates.
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/lizlaffitte/hogwarts. 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.
Looking for a specific way to contribute? How about allowing users to see a list of professors, or house ghosts? Good luck, wizards!
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Hogwarts project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.