Hyrule Compendium (BOTW)

This site provides a fun way to browse an encyclopedia of all the interactive items found in the world of Hyrule, Breath of the Wild.

Live Demo:

Check it out: Hyrule Compendium

Features

• View items by category by using the navigation buttons
• View item details by clicking on something of interest
  • Detailed info includes: common locations, cooking effect, description, dlc, edible, hearts recovered, weapon stats (attack, defense)
• Search by name; includes fuzzy searching for typos and close matches
• Dockerized for seamless production and deployment

Screenshots:

🔍 Search by Name or ID

📑 List by Category

ℹ Learn All About It!

Getting Started

Setup

1. Clone the repository

   git clone https://github.com/amandadr/hyrule-compendium.git
   cd hyrule-compendium

2. Install Docker (Optional)

   • Follow the intructions on the 'get Docker' site.

Usage

Use the traditional npm i, npm start combo, or...

1. Build the Docker image:

docker build -t hyrule:latest .

2. Build the Docker container:

docker run -d -p 4000:80 --name hyrule-compendium hyrule:latest

3. Find the app at localhost:4000 - have fun :)

API Dependency

With major thanks to gadhagod for putting together a wonderful API

Changelog

...

• Updated 2024-03-21:
  • Integrated a Lambda-hosted fuzzy search function which filters search terms before requesting entries from the API. This allows users to input partial terms or typos and return accurate results!
• Updated 2024-05-19:
  • Dockerized the application.