The goal of leaguestats.gg is to provide global complete data for all League of Legends summoners.
Here is an example of stats for some summoner.
Development environment requirements :
- Node.js >= 18.0.0
- PostgreSQL
- Redis
You can use the docker-compose.yml
file to quickly setup PostgreSQL and Redis in development.
Setting up the docker container:
> docker-compose up --build -d
Setting up your development environment on your local machine :
> git clone https://github.com/vkaelin/LeagueStats.git
> cd leaguestats/client
> npm install
# And
> cd leaguestats/server
> npm install
> cp .env.example .env # edit the values (see below for more info)
> node ace migration:run
Before running the migrations, you need to add some details to the server .env:
-
To generate the APP_KEY run
node ace generate:key
, copy and paste the value on the respective .env variable; -
Set the database variables PG_USER, PG_PASSWORD and PG_DB_NAME. If you are using docker, you can set as below:
PG_USER=root
PG_PASSWORD=root
PG_DB_NAME=leaguestats
- For the application work properly, you need a Riot API Key to set it on RIOT_API_KEY .env variable. To know more, take a look to their documentation on this link.
Running the app :
> cd client
> npm run dev
# And
> cd server
> npm run dev
Deploying the app :
> cd client
> npm run build
> npm run preview # to test the build locally
# And
> cd server
> npm run build
> node build/server.js
Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.
NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)
https://creativecommons.org/licenses/by-nc-sa/4.0/
Share โ copy and redistribute the material in any medium or format
Adapt โ remix, transform, and build upon the material
NonCommercial โ You may not use the material for commercial purposes.
ShareAlike โ If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.