From 8d770fa9fb8d0004f644ba4313349c54fde30f56 Mon Sep 17 00:00:00 2001 From: JP1998 Date: Wed, 7 Nov 2018 14:43:54 +0100 Subject: [PATCH] Update README with an install description --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12eb3d6..5f8c36e 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -# turniere-frontend \ No newline at end of file +# turniere-frontend + +## 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 + +First of course you'll need to clone this repository: + +``` +$ git clone https://github.com/turniere/turniere-frontend.git +``` + +Afterwards you'll have to navigate into the created folder and install React aswell as Express with your pacakge manager: + +``` +$ yarn add --save react react-dom next express +``` + +Afterwards you may simply run the developer version of the project: + +``` +$ yarn run dev +```