Skip to content

GitHixy/WoW-Checker

Repository files navigation

WoW Checker

A React-based web application that allows users to search and view World of Warcraft character and guild stats using the Raider.io API.

Features

  • Character search with detailed stats display
  • Guild search with raid progression and member details
  • Mythic+ scores and best runs for characters
  • Manual realm entry or selection from popular realms
  • Responsive design for both desktop and mobile
  • Beautiful World of Warcraft themed UI

How Realm Names Work

This application allows you to search for characters and guilds in two ways:

  1. By manually typing the realm name
  2. By selecting from a list of popular realms for each region

When entering a realm name manually, the app automatically converts it to the "slug" format required by the Raider.io API:

  • Spaces are replaced with hyphens
  • Special characters are removed
  • All text is converted to lowercase

For example, "Mal'Ganis" becomes "malganis" and "Area 52" becomes "area-52".

Technologies Used

  • React 18
  • React Router
  • Vite
  • CSS Modules
  • Axios
  • Raider.io API

Getting Started

Prerequisites

  • Node.js (v14+)
  • npm or yarn

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/wow-checker.git
    cd wow-checker
    
  2. Install dependencies:

    npm install
    
  3. Run the development server:

    npm run dev
    
  4. Open your browser and navigate to http://localhost:5173

Building for Production

To build the app for production:

npm run build

The build will be created in the dist directory.

Deployment

This project is set up to be deployed on Netlify. Simply connect your GitHub repository to Netlify, and it will automatically build and deploy your application.

API Usage

This project uses the Raider.io API to fetch character and guild data. The API is free to use and does not require authentication for the endpoints used in this application.

License

MIT

Acknowledgements

  • Raider.io for providing the API
  • World of Warcraft and Blizzard Entertainment for the game and inspiration
  • React and Vite for the development framework

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published