docs: update summoner example + README

This commit is contained in:
Valentin Kaelin 2023-09-21 14:01:01 +02:00
parent bd63a31202
commit 889360fbed
No known key found for this signature in database
GPG key ID: B389A4E3DFF8E414
3 changed files with 6 additions and 5 deletions

View file

@ -4,7 +4,7 @@
<a href="https://discord.gg/RjBzjfk"><img src="https://img.shields.io/badge/Discord-join%20chat-738bd7.svg" alt="LeagueStats.gg official Discord"></a> <a href="https://discord.gg/RjBzjfk"><img src="https://img.shields.io/badge/Discord-join%20chat-738bd7.svg" alt="LeagueStats.gg official Discord"></a>
The goal of [leaguestats.gg](https://leaguestats.gg) is to provide global complete data for all League of Legends summoners. The goal of [leaguestats.gg](https://leaguestats.gg) is to provide global complete data for all League of Legends summoners.
Here is an [example](https://leaguestats.gg/summoner/euw/KCRekkles) of stats for some summoner. Here is an [example](https://leaguestats.gg/summoner/euw/KCNEXTADKING) of stats for some summoner.
![Screenshot](https://res.cloudinary.com/kln/image/upload/v1615669773/repository-preview-leaguestats.jpg) ![Screenshot](https://res.cloudinary.com/kln/image/upload/v1615669773/repository-preview-leaguestats.jpg)
@ -14,11 +14,11 @@ Here is an [example](https://leaguestats.gg/summoner/euw/KCRekkles) of stats for
Development environment requirements : Development environment requirements :
- [Node.js](https://nodejs.org/en/download/) >= 12.0.0 - [Node.js](https://nodejs.org/en/download/) >= 18.0.0
- [PostgreSQL](https://www.postgresql.org/download/) - [PostgreSQL](https://www.postgresql.org/download/)
- [Redis](https://redis.io/download) - [Redis](https://redis.io/download)
You can use the `docker-compose.yml` file to quickly setup Postgre and Redis in development. You can use the `docker-compose.yml` file to quickly setup PostgreSQL and Redis in development.
Setting up the docker container: Setting up the docker container:
@ -77,6 +77,7 @@ Deploying the app :
```bash ```bash
> cd client > cd client
> npm run build > npm run build
> npm run preview # to test the build locally
# And # And

View file

@ -69,7 +69,7 @@
<SearchFormDropdownPlayer <SearchFormDropdownPlayer
@close="close" @close="close"
@mousemove.native="onHover(1)" @mousemove.native="onHover(1)"
:player="{ name: 'KC Rekkles', icon: 7, region: 'euw' }" :player="{ name: 'KC NEXT ADKING', icon: 29, region: 'euw' }"
:selected="selected === 1" :selected="selected === 1"
:favorites-list="false" :favorites-list="false"
/> />

View file

@ -5,7 +5,7 @@
"scripts": { "scripts": {
"dev": "node ace serve --watch", "dev": "node ace serve --watch",
"build": "node ace build --production", "build": "node ace build --production",
"start": "node server.js", "start": "node build/server.js",
"lint": "eslint . --ext=.ts", "lint": "eslint . --ext=.ts",
"format": "prettier --write ." "format": "prettier --write ."
}, },