thorough install instructions
This commit is contained in:
parent
475aa11f06
commit
8b79d64c3d
23
README.md
23
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
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user