mirror of
https://github.com/vkaelin/LeagueStats.git
synced 2026-03-25 12:57:28 +00:00
docs: update README
This commit is contained in:
parent
da369edb5b
commit
1d1e27e31c
1 changed files with 58 additions and 27 deletions
85
README.md
85
README.md
|
|
@ -1,37 +1,68 @@
|
||||||
# LeagueStats
|
# LeagueStats
|
||||||
|
|
||||||
## Global dependencies
|
[](https://app.netlify.com/sites/leaguestats-gg/deploys)
|
||||||
```
|
|
||||||
Vue CLI
|
|
||||||
Adonis CLI
|
The goal of [leaguestats.gg](https://leaguestats.gg) is to provide global complete data for all League of Legends summoners.
|
||||||
MongoDB
|
|
||||||
|

|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Development environment requirements :
|
||||||
|
- [MongoDB](https://www.mongodb.com/download-center/community)
|
||||||
|
- [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
|
||||||
|
> cp .env.example .env
|
||||||
|
> adonis migration:run
|
||||||
```
|
```
|
||||||
|
|
||||||
## Project setup
|
## Useful commands
|
||||||
```
|
Running the app :
|
||||||
cd client
|
```bash
|
||||||
npm install
|
> cd client
|
||||||
|
> npm run serve
|
||||||
|
|
||||||
cd server
|
# And
|
||||||
npm install
|
|
||||||
cp .env.example .env
|
> cd server
|
||||||
adonis migration:run
|
> adonis serve --dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### Compiles and hot-reloads for development
|
Building the app :
|
||||||
```
|
```bash
|
||||||
cd client
|
> cd client
|
||||||
npm run serve
|
> npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
### Compiles and minifies for production
|
## Contributing
|
||||||
```
|
|
||||||
cd client
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
### Run NodeJS server
|
Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.
|
||||||
```
|
|
||||||
cd server
|
## License
|
||||||
adonis serve --dev
|
|
||||||
```
|
NonCommercial-ShareAlike 1.0 Generic (CC NC-SA 1.0)
|
||||||
|
https://creativecommons.org/licenses/nc-sa/1.0/
|
||||||
|
|
||||||
|
### You are free to:
|
||||||
|
|
||||||
|
Share — copy and redistribute the material in any medium or format
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue