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

feat: add .env details to the readme

Browse source
This commit is contained in:
Lana Schuster 2022-08-17 13:51:55 -03:00
parent 9481ee8bd7
commit 5311a1c9b9
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -20,6 +20,12 @@ Development environment requirements :
You can use the `docker-compose.yml` file to quickly setup Postgre and Redis in development.
Setting up the docker container:
```bash
> docker-compose up --build -d
```
Setting up your development environment on your local machine :
```bash
@ -35,6 +41,24 @@ Setting up your development environment on your local machine :
> node ace migration:run
```
### Env Values
Before running the migrations, you need to add some details to the server .env:
1. To generate the APP_KEY run ```node ace generate:key```, copy and paste the value on the respective .env variable;
2. Set the database variables PG_USER, PG_PASSWORD and PG_DB_NAME. If you are using docker,
you can set as below:
```
PG_USER=root
PG_PASSWORD=root
PG_DB_NAME=leaguestats
```
3. For the application run properly, you need and Riot API Key and set it to the RIOT_API_KEY .env variable. To know more, take a look to their documentation on [this link](https://developer.riotgames.com/).
## Useful commands
Running the app :