mirror of
https://github.com/vkaelin/LeagueStats.git
synced 2026-03-25 04:47:27 +00:00
docs: little update on the README (will need more tweaks)
This commit is contained in:
parent
4aa25b6a8b
commit
e4d8ca5873
4 changed files with 9 additions and 5 deletions
13
README.md
13
README.md
|
|
@ -3,7 +3,6 @@
|
|||
[](https://app.netlify.com/sites/leaguestats-gg/deploys)
|
||||
<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.
|
||||
Here is an [example](https://leaguestats.gg/summoner/euw/SammyWinchester) of stats for some summoner.
|
||||
|
||||
|
|
@ -18,11 +17,15 @@ Here is an [example](https://leaguestats.gg/summoner/euw/SammyWinchester) of sta
|
|||
## Installation
|
||||
|
||||
Development environment requirements :
|
||||
|
||||
- [Node.js](https://nodejs.org/en/download/) >= 12.0.0
|
||||
- [MongoDB](https://www.mongodb.com/download-center/community) >= 4.4
|
||||
- [PostgreSQL](https://www.postgresql.org/download/)
|
||||
- [Redis](https://redis.io/download)
|
||||
|
||||
You can use the `docker-compose.yml` file to quickly setup Postgre and Redis in development.
|
||||
|
||||
Setting up your development environment on your local machine :
|
||||
|
||||
```bash
|
||||
> git clone https://github.com/vkaelin/LeagueStats.git
|
||||
> cd leaguestats/client
|
||||
|
|
@ -33,11 +36,13 @@ Setting up your development environment on your local machine :
|
|||
> cd leaguestats/server
|
||||
> npm install
|
||||
> cp .env.example .env # edit the values
|
||||
> node ace mongodb:migration:run # your MongoDB installation needs to by a Replica Set and not a Standalone
|
||||
> node ace migration:run
|
||||
```
|
||||
|
||||
## Useful commands
|
||||
|
||||
Running the app :
|
||||
|
||||
```bash
|
||||
> cd client
|
||||
> npm run dev
|
||||
|
|
@ -49,6 +54,7 @@ Running the app :
|
|||
```
|
||||
|
||||
Deploying the app :
|
||||
|
||||
```bash
|
||||
> cd client
|
||||
> npm run build
|
||||
|
|
@ -77,7 +83,6 @@ Adapt — remix, transform, and build upon the material
|
|||
|
||||
### Under the following terms:
|
||||
|
||||
|
||||
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.
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue