The Hyrule Compendium 🧝🏻‍♂️

This app displays in-game items from The Legend of Zelda: Breath of the Wild.

You can view the app live on GitHub Pages.

API

The app fetches data from the open-source Hyrule Compendium API, which provides information for in-game items and regions from Breath of the Wild. The API has excellent documentation and is very easy to work with.

UI Design

I went with a clean/minimalist design for the app. I've already built a similar project with a more out-there design, (see, OSRS Stock App), so this was a nice change of pace.

The app uses components from shadcn/ui and is styled with Tailwind.

Features

• Smooth Page Transitions
• Dark Mode Support
• Pagination
• Search

Areas for Improvement

I'm not fully satisfied with my use of pagination for the category pages. If I were to work on the app further, I would probably implement a continuous scroll feature instead.

Running Locally

1. Clone the repository

$ git clone https://github.com/austin-weeks/Hyrule-Compendium.git

2. Install node dependencies

$ npm install

3. Run the app with Vite

$ npm run dev