Skip to content

An open-source website displaying statistics for League of Legends players with data fetching from Riot Games API

License

Notifications You must be signed in to change notification settings

kloczewiak/orange-minion

Repository files navigation

Orange Minion

Orange Minion is an open-source website offering a collection of tools for League of Legends.

Built with Next.js, this project provides easy-to-use tools to display champion mastery, track match history with friends, and more in the future.

Features

Mastery Showcase

Easily view and showcase your champion masteries in a visually appealing layout.

Mastery showcase page

Shared Match History

Quickly view all games you have played with another player, allowing you to analyze your shared history and collaboration.

Shared match history page

Contributing

Contributions are welcome! If you have an idea for a new feature or improvements, feel free to submit a pull request. Before contributing, please check the Issues tab to see if there are any outstanding items that could use your help.

How to Contribute

  1. Fork the repository and create a new branch for your feature or fix.
  2. Make your changes, and ensure your code adheres to the project’s coding standards.
  3. Submit a pull request, detailing the changes and why they are beneficial.

Getting Started

If you're interested in contributing, follow these instructions to set up a local development environment.

Prerequisites

  • pnpm (Package manager used for managing project dependencies)
  • A Riot API key, which you can obtain from the Riot Developer Portal.

Installation

Clone the repository and install dependencies:

pnpm install

Add your Riot API key to a .env.local file in the project root:

RIOT_API_KEY=your_riot_api_key_here

Running the Development Server

Start the development server:

pnpm dev

Open http://localhost:3000 in your browser to view the application.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Acknowledgments

  • This project was bootstrapped with create-next-app.
  • Thanks to the open-source community and League of Legends enthusiasts who help make this project better.

Enjoy using Orange Minion, and may your games be ever victorious!

About

An open-source website displaying statistics for League of Legends players with data fetching from Riot Games API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages