Doble/LeagueStats
1
0
Fork 0
mirror of https://github.com/vkaelin/LeagueStats.git synced 2026-03-25 21:07:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update README

Browse source
This commit is contained in:
Valentin Kaelin 2020-10-16 22:41:09 +02:00
parent 77eb091b11
commit 581ce52871
1 changed files with 13 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -18,10 +18,9 @@ Here is an [example](https://leaguestats.gg/summoner/euw/Alderiate) of stats for
## Installation ## Installation
Development environment requirements : Development environment requirements :
- [Node.js](https://nodejs.org/en/download/) - [Node.js](https://nodejs.org/en/download/) >= 12.0.0
- [MongoDB](https://www.mongodb.com/download-center/community) - [MongoDB](https://www.mongodb.com/download-center/community) >= 4.4
- [Redis](https://redis.io/download) - [Redis](https://redis.io/download)
- [Adonis CLI](https://github.com/adonisjs/adonis-cli)
Setting up your development environment on your local machine : Setting up your development environment on your local machine :
```bash ```bash
@ -33,26 +32,32 @@ Setting up your development environment on your local machine :
> cd leaguestats/server > cd leaguestats/server
> npm install > npm install
> cp .env.example .env > cp .env.example .env # edit the values
> adonis migration:run > node ace mongodb:migration:run # your MongoDB installation needs to by a Replica Set and not a Standalone
``` ```
## Useful commands ## Useful commands
Running the app : Running the app :
```bash ```bash
> cd client > cd client
> npm run serve > npm run dev
# And # And
> cd server > cd server
> adonis serve --dev > npm run dev
``` ```
Building the app : Deploying the app :
```bash ```bash
> cd client > cd client
> npm run build > npm run build
# And
> cd server
> npm run build
> node build/server.js
``` ```
## Contributing ## Contributing