From 8b79d64c3d12ec1395407b7529e7bb3c0d399786 Mon Sep 17 00:00:00 2001 From: Ruben Barkow-Kuder Date: Wed, 4 Mar 2020 02:24:03 +0100 Subject: [PATCH] thorough install instructions --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 903f4f1..2ac5840 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,26 @@ This project is built using [react-admin](https://marmelab.com/react-admin/). Use `yarn install` after cloning this repo. Use `yarn start` to launch the webserver. + +## Step-By-Step install: + +You have two options: + + 1. Download the source code from github and run using nodejs + 2. Run the Docker container + +Steps for 1): + +- install `git`: `apt install git` +- install `nodejs`: `snap install --channel=12/stable --classic node` +- download the source code: `git clone https://github.com/Awesome-Technologies/synapse-admin.git` +- go into download directory: `cd synapse-admin` +- download dependencies: `yarn install` +- start web server: `yarn start` + + +Steps for 2): + +- run the Docker container: `docker run -p8080:80 awesometechnologies/synapse-admin` +- go to http://localhost:8080 +