https://github.com/wolven531/simpleleaguecompare

Web UI to help compare + query LoL game stats
https://github.com/wolven531/simpleleaguecompare

league league-api league-of-legends league-of-legends-api leagueoflegends nestjs nestjs-backend react reactjs riot riot-api summoner typescript

Last synced: 9 days ago
JSON representation

Web UI to help compare + query LoL game stats

• Host: GitHub
• URL: https://github.com/wolven531/simpleleaguecompare
• Owner: Wolven531
• License: mit
• Created: 2020-04-22T01:49:16.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-04T15:53:36.000Z (almost 2 years ago)
• Last Synced: 2024-11-07T03:16:06.913Z (about 2 months ago)
• Topics: league, league-api, league-of-legends, league-of-legends-api, leagueoflegends, nestjs, nestjs-backend, react, reactjs, riot, riot-api, summoner, typescript
• Language: TypeScript
• Homepage:
• Size: 5.2 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SimpleLeagueCompare

SimpleLeagueCompare is a web UI based interface designed to help query and compare the game stats for myself and my two friends.

## Running

### Windows

1. Boot up the API. Double click (or launch via command line) `start-api-on-windows.cmd`

1. Boot up the website. Double click (or launch via command line) `start-web-on-windows.cmd`

1. The URL [http://localhost:3000](http://localhost:3000) should open in the system's default web browser

### MacOS

1. Boot up the API. Using terminal, execute `start-api-on-mac.sh`

1. Boot up the website. Using terminal, execute `start-web-on-mac.sh`

1. The URL [http://localhost:3000](http://localhost:3000) should open in the system's default web browser

## Notes

* You may want to add the following line to your hosts file on Windows (located at `C:\Windows\System32\drivers\etc\hosts`)

  * `127.0.0.1            simpleleaguecompare` (whitespaces are ignored)

  * NOTE: Making changes to the hosts file requires admin access

  * Afterward, you can use the running app at [simpleleaguecompare:3000](http://simpleleaguecompare:3000)

* To launch a command temrinal into a running container, use `docker exec -it {CONTAINER} sh`

  * The `CONTAINER` fragment is the name assigned to a running container after it is started using the `slc-api` image

### IDs

* `0NevErOddOrEveN0`

  * `hcLRomxparq_5yiMDPH-dS3iLiw4xCZhGu-pxv-uviArAiog` (summoner id, `id` in Riot API)

  * `U9b-KVWyJkTpQR0YiPJt7U8DFqy5llDfTJZYV56-G7onXevEOMC_DiI1` (encrypted acct id, `accountId` in Riot API)

  * `2096605473991232` (acct id, from matchhistory URL on leagueoflegends.com)

* `NicoleLovesMusic`

  * `G5tCj_5KLJajQ4V6PtbYjRlY_s3lRwY0ubNe4EM-NL3pG408`

  * `Cn0MOwyHpDXOLaCqpbkwMoIs1M8r9IJnv39DOM867E1zTjE`

  * `221463284`

* `DucksInAC0at`

  * `Dm9zNbtMP8bqWlSsVgkPeu-ZwuRJbjKzn-BUvO1hiyXjyfC1`

  * `aME0ZGruQhV8etyYYIys4vqFarj13QyvFztnwVIHImEgEgiwl7OLPsRE`

  * `2237249085049216`

* `merlin1320`

  * `ambil30qwgVvs2ud1K_z2lKxZxK1Rsuy7fqMHssNT0RX5f0`

  * `Z8ufPKNP9ZpxH1YTirB3axCZKXFAgYc46rPrxRjwQHtGog`

  * `33796450`

* `ElLocoNegro`

  * `iQf-PRosKC7dU_JY9kYk8jYVq4n9QpQytEE3TxD_nuDrDEY`

  * `OCamYtFbkjSq9tK5lMQ2KLCcFHFL0iwTv-KyAiJnIgylmw`

  * `43944526`

### API Endpoints

* [get by summoner name](https://developer.riotgames.com/apis#summoner-v4/GET_getBySummonerName)

  * Looks like `/lol/summoner/v4/summoners/by-name/{summonerName}`

* [get match list](https://developer.riotgames.com/apis#match-v4/GET_getMatchlist)

  * Looks like `/lol/match/v4/matchlists/by-account/{encryptedAccountId}`

## To-do

* ✅ Save to and load from users file to prevent API overchat

  * ✅ Save

  * ✅ Load

  * ✅ Optimize fire time

* ✅ Add models for each of the DTOs from Riot (relevant ones are added as needed)

* ✅ Add shared models (between API and web)

* ✅ Display last three matches for each player

  * ✅ Adjustable

  * ✅ Perhaps limit to last 100 games

  * ✅ Display average gold over last matches

  * ✅ Display average KDA over last matches

    * ✅ Display average assists over last matches

    * ✅ Display average deaths over last matches

    * ✅ Display average kills over last matches

* ✅ Docker-ize

    * ✅ Setup Dockerfile for API

    * ✅ Setup Dockerfile for web

    * ✅ Setup docker-compose to utilize both API and web Dockerfiles

* Display champion mastery for each player

  * List mastery for each available champion

  * ✅ List total mastery achieved

* ⏳ Enhance Swagger documentation using OpenAPI decorators [more info](https://docs.nestjs.com/openapi/decorators)

* Rate limits ?

* Incorporate game constants from the [docs](https://developer.riotgames.com/docs/lol#general_game-constants)

* Display most played champs for each player

  * Perhaps limit to top three champs (not all of them)

* Add stat-based awards

  * Highest KDA

  * Highest KDR

  * Highest Gold Earned

  * Highest damage to champs

  * Highest damage taken

  * Highest damage to objectives