LeagueStats/README.md

84 lines
2.3 KiB
Markdown
Raw Normal View History

2019-09-11 08:09:58 +00:00
# LeagueStats
2019-04-07 17:54:02 +00:00
2019-12-07 21:58:19 +00:00
[![Netlify Status](https://api.netlify.com/api/v1/badges/caa8be10-e095-4934-81ef-b662fb73483f/deploy-status)](https://app.netlify.com/sites/leaguestats-gg/deploys)
2020-04-03 10:59:02 +00:00
<a href="https://discord.gg/RjBzjfk"><img src="https://img.shields.io/badge/Discord-join%20chat-738bd7.svg" alt="LeagueStats.gg official Discord"></a>
2019-04-07 17:54:02 +00:00
2019-04-07 18:04:18 +00:00
2020-02-10 20:21:22 +00:00
The goal of [leaguestats.gg](https://leaguestats.gg) is to provide global complete data for all League of Legends summoners.
2021-03-06 17:07:23 +00:00
Here is an [example](https://leaguestats.gg/summoner/euw/MattDonovan) of stats for some summoner.
2019-04-07 17:54:02 +00:00
2020-02-05 20:44:21 +00:00
![Screenshot](https://res.cloudinary.com/kln/image/upload/v1580935119/leaguestats-preview.png)
2019-04-07 17:54:02 +00:00
<p>
<a href="https://www.digitalocean.com/">
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg" width="201px">
</a>
</p>
2019-12-07 21:58:19 +00:00
## Installation
Development environment requirements :
2020-10-16 20:41:09 +00:00
- [Node.js](https://nodejs.org/en/download/) >= 12.0.0
- [MongoDB](https://www.mongodb.com/download-center/community) >= 4.4
2019-12-07 21:58:19 +00:00
- [Redis](https://redis.io/download)
Setting up your development environment on your local machine :
```bash
> git clone https://github.com/vkaelin/LeagueStats.git
> cd leaguestats/client
> npm install
# And
> cd leaguestats/server
> npm install
2020-10-16 20:41:09 +00:00
> 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
2019-04-07 17:54:02 +00:00
```
2019-12-07 21:58:19 +00:00
## Useful commands
Running the app :
```bash
> cd client
2020-10-16 20:41:09 +00:00
> npm run dev
2019-12-07 21:58:19 +00:00
# And
> cd server
2020-10-16 20:41:09 +00:00
> npm run dev
2019-04-07 17:54:02 +00:00
```
2019-12-07 21:58:19 +00:00
2020-10-16 20:41:09 +00:00
Deploying the app :
2019-12-07 21:58:19 +00:00
```bash
> cd client
> npm run build
2020-10-16 20:41:09 +00:00
# And
> cd server
> npm run build
> node build/server.js
2019-04-07 17:54:02 +00:00
```
2019-12-07 21:58:19 +00:00
## Contributing
Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.
## License
NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)
https://creativecommons.org/licenses/by-nc-sa/4.0/
2019-12-07 21:58:19 +00:00
### You are free to:
Share — copy and redistribute the material in any medium or format
2019-12-07 21:58:19 +00:00
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.