turniere
/
turniere-frontend
mirror of https://github.com/turniere/turniere-frontend.git
1
0
Fork 0
Code Issues Releases Wiki Activity

update README.md

This commit is contained in:
Felix Hamme 2019-05-08 13:37:29 +02:00
parent 88d4f1dae8
commit 6b4e0c36a5
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,10 +1,11 @@
# turniere-frontend
## Prerequisites
## Development Setup
### Prerequisites
You'll need Node.js and a package manager for Node.js (like npm or Yarn; We recommend Yarn) installed on your system in order to run this program. You can see how to install Node.js [here](https://nodejs.org/en/).
## Setup the project
### Setup the Project
First of course you'll need to clone this repository:
@ -18,8 +19,18 @@ Afterwards you'll have to install the used libraries using following command:
$ yarn install
```
Afterwards you may simply run the developer version of the project:
Then you can run the development server by executing:
```
$ TURNIERE_API_URL=https://api.example.com yarn run dev
```
The environment variable `TURNIERE_API_URL` must contain an valid url to a [turniere backend server](https://github.com/turniere/turniere-backend).
In production environment the server runs on port 80, otherwise on port 3000.
## Production Setup: Build the Docker Container
```
$ yarn run dev
$ docker build -t turniere-frontend:latest .
```
The built container exposes port 80.