Wolven531 / simple-nest-app

An app created w/ NestJS to consume and transform Riot API League data

simple-nest-app

This is a NestJS app that acts as the "go between" for frontend apps that want data from Riot's API

Running

From repository root directory - yarn start:dev

Notes

This app requires a token to communicate w/ Riot's servers. You can generate one here

When running locally, make sure to set required environment variables before attempting to boot the app; otherwise, the default values from the .env file (at the repository root directory) will be used, which are intentionally invalid

In PowerShell -

$env:RIOT_SECRET="YOUR_RIOT_TOKEN_HERE"
$env:SERVER_SECRET="YOUR_SERVER_SECRET_HERE"

To-do

• add GHA that runs e2e tests
• add rate limiting for requests that would exceed Riot API rate limit
• add endpoint to get all champion masteries for a summoner
• add queue type param for stats (filter by queue)
• add examples to swagger docs
• improve query and param swagger docs
• remove API key param from mastery service method signatures (inject AppService into MasteryService)