A RESTful OPEN API for Harry Potter World

Setup project at local and make contributions 🤓

Fork project

• Fork project in to your personal account and create a new branch with issue name, for example:

issue_1_new_characters

Clone project

• Now you should clone the project from forked version in your account. It'll look like this:

git clone [email protected]:yourAccount/harry_potter_open_api.git

Local setup

• Create database.yml file setup with your local database configuration. You can use next guide

• Install gems

bundle install

• Create the database with the following command in the terminal:

rails db:create

• Run migrations:

rails db:migrate

• Build data run the next command

rails hp_build:data

🙌 Now you can work and make your contribution!

• Run the server

rails server
# or 
rails s

All contributions are welcome: bug fixes, data contributions, recommendations.

TO DO 👀

Models

• Wizard Professions
• Spells
• Potions

🗒 Documentation

Endpoints

Schools -> https://harry-potter-open-api.herokuapp.com/api/v1/schools

School houses -> https://harry-potter-open-api.herokuapp.com/api/v1/school_houses

School house -> https://harry-potter-open-api.herokuapp.com/api/v1/school_houses/1

Characters -> https://harry-potter-open-api.herokuapp.com/api/v1/people

Character -> https://harry-potter-open-api.herokuapp.com/api/v1/people/1

Students -> https://harry-potter-open-api.herokuapp.com/api/v1/people/students

Creatures -> https://harry-potter-open-api.herokuapp.com/api/v1/creatures

Creature -> https://harry-potter-open-api.herokuapp.com/api/v1/creatures/1

👏 Credits

Many thanks to:

• Harry Potter Wiki for all the information published about Harry Potter World.
• Wizards Unite Hub for resources published.
• Szokekiss Marton for the illustrations of the creatures.

📃 License

This project is available as open source under the terms of the MIT License.