diff --git a/README.md b/README.md index 903f4f1..ba6c7d4 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,28 @@ 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): + +- make sure you have installed the following: git, yarn, nodejs +- download the source code: `git clone https://github.com/Awesome-Technologies/synapse-admin.git` +- change into downloaded directory: `cd synapse-admin` +- download dependencies: `yarn install` +- start web server: `yarn start` + +Steps for 2): + +- run the Docker container: `docker run -p 8080:80 awesometechnologies/synapse-admin` +- browse to http://localhost:8080 + +## Screenshots + +![Screenshots](./screenshots.jpg) diff --git a/screenshots.jpg b/screenshots.jpg new file mode 100644 index 0000000..9a08375 Binary files /dev/null and b/screenshots.jpg differ