Skip to content

REST API used in conjunction with the LOLOT web application, which allows League of Legends players to keep track of their Hextech Chest rewards via Champion Mastery for the current season.

abaran30/lolot-api

Repository files navigation

LOLOT API

LOLOT API is a REST API used in conjunction with the LOLOT UI web application, which allows League of Legends players to keep track of their Hextech Chest rewards via Champion Mastery for the current season.

Development

This REST API was developed using FeathersJS.

Configuration

Riot Games API Key

A Riot Games API key is required to use this REST API. The REST API is set up to consume the API key via environment variable RIOT_GAMES_API_KEY (see config.js). You can obtain an API key from the Riot Games Developer portal.

CORS

The REST API is using CORS and an origin has to be set (see app.js). The origin can be set to environment variable LOLOT_ORIGIN (see config.js).

How to Set Up and Run Locally

Prerequisites

  • Make sure the aforementioned Configuration options have been addressed.
  • Make sure Git, Node.js, and npm are installed and configured on your machine.

Steps

  1. Clone this repository to a location of your choosing.

  2. Inside the cloned directory, run:

npm install
  1. Once the npm packages have been installed, run:
npm start
  1. The REST API will start locally on http://localhost:8080 (port set by default).

Testing

Testing is configured to use Mocha, Chai, and Nock, with nyc used to report coverage.

To run the tests, run:

npm test

Disclaimer

LOLOT isn’t endorsed by Riot Games and doesn’t reflect the views or opinions of Riot Games or anyone officially involved in producing or managing League of Legends. League of Legends and Riot Games are trademarks or registered trademarks of Riot Games, Inc. League of Legends © Riot Games, Inc.

About

REST API used in conjunction with the LOLOT web application, which allows League of Legends players to keep track of their Hextech Chest rewards via Champion Mastery for the current season.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published