From 6b4e0c36a59eabd314addf93dd3d9a18662fac99 Mon Sep 17 00:00:00 2001 From: Felix Hamme Date: Wed, 8 May 2019 13:37:29 +0200 Subject: [PATCH] update README.md --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fde2c49..f75e18a 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file