Report a Bug · Request a Feature · Ask a Question · Issues

Hogwarts API

Table of Contents

• About ✨
• Developer Instructions 🪄
• Support 🙋
• Contributing 💪
• Authors & Contributors 👥
• Warranty 🔒
• License 📜

About ✨

The Hogwarts API is a magical API containing data from the wizarding world of Harry Potter, Hogwarts Legacy and the Fantastic Beasts universe. It includes information on characters, movies, soundtracks, books, quotes, spells, and potions, making it a valuable resource for developers who need some magical (test) data to use in their code projects.

Developer Instructions 🪄

Setup

Make sure to install the dependencies:

# yarn
yarn install

# npm
npm install

# pnpm
pnpm install

# bun
bun install

Development Server

Start the development server on http://localhost:3000

npm run dev

Production

Build the application for production:

npm run build

Locally preview production build:

npm run preview

Checkout the deployment documentation for more information.

Support 🙋

If you need any support, we're here to help! You can ask your question on the GitHub Discussions to get help from the community or open a GitHub issue to report a bug or request a feature. Our team will respond to your issue as soon as possible. We're committed to providing the best support possible to our users.

If you want to say thank you or/and support active development of Hogwarts API:

• Add a GitHub Star to the project.
• Engage with the community on GitHub Discussions.
• Write interesting articles about the project on Dev.to, Medium or your personal blog.

Contributing 💪

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

If you want to help with the project make sure to look at the Issues and leave a note if you want to work on something.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Please read our contribution guidelines, and thank you for being involved!

Authors & Contributors 👥

The original setup of this repository is by Ivo Pauly-Koelewijn and starter template shadcn-docs-nuxt is used.

For a full list of all authors and contributors, see the contributors page.

Warranty 🔒

Hogwarts API is provided "as is" without any warranty. Use at your own risk.

License 📜

This project is licensed under the MIT license.

See LICENSE for more information.