https://github.com/wolven531/simple-nest-app

An app created w/ NestJS to consume and transform Riot API League data
https://github.com/wolven531/simple-nest-app

gitlab gitlab-ci gql graphql graphql-server heroku-deployment league league-api league-of-legends league-of-legends-api leagueoflegends nest nestjs riot-api riot-games riot-games-api swagger swagger-ui ts typescript

Last synced: 26 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/wolven531/simple-nest-app
• Owner: Wolven531
• License: mit
• Created: 2021-05-27T02:07:57.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-19T05:02:21.000Z (about 3 years ago)
• Last Synced: 2024-11-07T03:16:06.872Z (3 months ago)
• Topics: gitlab, gitlab-ci, gql, graphql, graphql-server, heroku-deployment, league, league-api, league-of-legends, league-of-legends-api, leagueoflegends, nest, nestjs, riot-api, riot-games, riot-games-api, swagger, swagger-ui, ts, typescript
• Language: TypeScript
• Homepage: https://simple-nest-staging.herokuapp.com
• Size: 4.32 MB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://developer.riotgames.com)

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 -

```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

- [x] add endpoint to get all champion masteries for a summoner

- [x] add queue type param for stats (filter by queue)

- [x] add examples to swagger docs

- [x] improve query and param swagger docs

- [x] remove API key param from mastery service method signatures (inject AppService into MasteryService)