Breath of the Wild Encyclopedia

📗 Table of Contents

• 📗 Table of Contents
• 📖 space-travelers-capstone
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Author
  • 🔭 Future Features
  • Walkthrough
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Breath of the wild Encyclopedia

This web application is a Single Page Application (SPA) serving as an encyclopedia for all the interactive in-game items in the world of Hyrule. It is built using React and Redux Toolkit and includes unit tests using React Testing Library.

🛠 Built With

Tech Stack

• HTML
• JS
• CSS
• React
• Redux Toolkit (RTK)

Client

- HTML
- JS
- CSS
- React

Server

- Null

Database

- Null

Key Features

• Web app using React
• Client-side routing using React Router V6
• Gitflow is used correctly
• Work is documented in a professional manner
• Following best practices for HTML, CSS, JS

BotwCapstone.webm

🚀 Live Demo

You can see the live demo of this project: click here

You can see a video description here : click here

⏫ Updated Version 11-08-2023, Added Desktop Version and Updated Mobile

botwD.webm

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

• A web browser
• A code editor
• A terminal

Setup

Clone this repository to your desired folder:

  git clone https://github.com/CesarHerr/metrics_webapp_botw.git

Install

Install this project with:

  cd metrics_webapp_botw
  npm install

Usage

To run the project on the webpack dev server, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm test

Deployment

  npm run deploy

(back to top)

👥 Author

👤 César Herrera

• GitHub: @cesarherr
• Twitter: @cesarherr2
• LinkedIn: cesarherr

🔭 Future Features

• Add more functions.

Walkthrough

In this project, we will be copying a given web design using React, Redux, and API handling. The design will serve as a reference for implementing the user interface and interactions. Please see the above sections if you want to copy and setup this project on your pc.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

If you like this project, give it a ⭐️!

(back to top)

🙏 Acknowledgments

I would like to thank Nelson Sakwa on Behance for the design, Microverse for giving us the opportunity to learn and grow as developers and also we like to thank our families, they are all our support. 🌟

(back to top)

📝 License

This project is MIT licensed.

(back to top)