Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ivopauly/hogwarts-api
The Hogwarts API is a magical API containing data from the wizarding world of Harry Potter, Hogwarts Legacy and the Fantastic Beasts universe.
https://github.com/ivopauly/hogwarts-api
api harry harry-potter harry-potter-api hogwarts hogwarts-legacy json nuxt potter
Last synced: 3 days ago
JSON representation
The Hogwarts API is a magical API containing data from the wizarding world of Harry Potter, Hogwarts Legacy and the Fantastic Beasts universe.
- Host: GitHub
- URL: https://github.com/ivopauly/hogwarts-api
- Owner: ivopauly
- License: mit
- Created: 2024-10-22T13:44:59.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-16T09:44:38.000Z (7 days ago)
- Last Synced: 2024-12-20T06:46:54.753Z (3 days ago)
- Topics: api, harry, harry-potter, harry-potter-api, hogwarts, hogwarts-legacy, json, nuxt, potter
- Language: TypeScript
- Homepage: https://hogwarts-api.com
- Size: 1.53 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://app.netlify.com/sites/hogwarts-api/deploys)
[](LICENSE)
[](https://github.com/ivopauly/hogwarts-api/stargazers)
[](https://github.com/ivopauly/hogwarts-api/graphs/contributors)
[](https://github.com/ivopauly/hogwarts-api/issues)
[](https://github.com/ivopauly/hogwarts-api/pulls)
[](https://github.com/ivopauly/hogwarts-api)
# Hogwarts API
Table of Contents
- [About ✨](#about-)
- [Developer Instructions 🪄](#developer-instructions-)
- [Support 🙋](#support-)
- [Contributing 💪](#contributing-)
- [Authors & Contributors 👥](#authors--contributors-)
- [Warranty 🔒](#warranty-)
- [License 📜](#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:
```bash
# yarn
yarn install
# npm
npm install
# pnpm
pnpm install
# bun
bun install
```
### Development Server
Start the development server on http://localhost:3000
```bash
npm run dev
```
### Production
Build the application for production:
```bash
npm run build
```
Locally preview production build:
```bash
npm run preview
```
Checkout the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
## Support 🙋
If you need any support, we're here to help! You can ask your question on the [GitHub Discussions](https://github.com/ivopauly/hogwarts-api/discussions) to get help from the community or open a [GitHub issue](https://github.com/ivopauly/hogwarts-api/issues/new/choose) 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](https://github.com/ivopauly/hogwarts-api) to the project.
- Engage with the community on [GitHub Discussions](https://github.com/ivopauly/hogwarts-api/discussions).
- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) 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](https://github.com/ivopauly/hogwarts-api) and leave a note if you want to work on something.
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
Please read [our contribution guidelines](CONTRIBUTING.md), and thank you for being involved!
## Authors & Contributors 👥
The original setup of this repository is by [Ivo Pauly-Koelewijn](https://github.com/ivopauly) and starter template [shadcn-docs-nuxt](https://github.com/ZTL-UwU/shadcn-docs-nuxt) is used.
For a full list of all authors and contributors, see [the contributors page](https://github.com/ivopauly/hogwarts-api/contributors).
## 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](LICENSE) for more information.
