TheEdgeOfRage
/
perktree
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Pavle Portic 2019-03-29 01:34:43 +01:00 committed by GitHub
parent fd83e9a61a
commit 5ff2bdfe99
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -8,12 +8,13 @@ Interactive DnD perktree written with django, vue and d3
The easiest way to run it is using docker-compose. The easiest way to run it is using docker-compose.
1. Create a `.env` file with the following entries 1. Create a `.env` file with the following entries
```
SECRET_KEY=[long random string] SECRET_KEY=[long random string]
DJANGO_ADMIN_USER=[username] DJANGO_ADMIN_USER=[username]
DJANGO_ADMIN_MAIL=[email] DJANGO_ADMIN_MAIL=[email]
DJANGO_ADMIN_PASS=[password] DJANGO_ADMIN_PASS=[password]
DB_PASSWORD=[database-password] DB_PASSWORD=[database-password]
```
2. Build the images with `docker-compose build` 2. Build the images with `docker-compose build`
3. Run it with `docker-compose up -d` 3. Run it with `docker-compose up -d`
@ -22,9 +23,11 @@ The easiest way to run it is using docker-compose.
### Normal ### Normal
1. Build the frontend 1. Build the frontend
- `cd frontend` ```
- `yarn/npm install` cd frontend
- `yarn/npm build` yarn/npm install
yarn/npm build
```
2. Install backend requirements from the pipfile using your python package manager of choice (though you should really use pipenv) 2. Install backend requirements from the pipfile using your python package manager of choice (though you should really use pipenv)
3. Set up a database (postgresql is recommended, though myql should work) 3. Set up a database (postgresql is recommended, though myql should work)
@ -34,3 +37,4 @@ The easiest way to run it is using docker-compose.
Though I do recommend running it with docker, as it's much easier to set up and maintain. Though I do recommend running it with docker, as it's much easier to set up and maintain.
4.