mirror of
https://github.com/UA-Fediland/synapse-admin.git
synced 2024-12-07 13:43:17 +00:00
Add screenshots and install instructions
Change-Id: Ibfede12d700924b7b3b01af5f3a3624f21a93862
This commit is contained in:
parent
6da3c8b885
commit
ab709aee3e
2 changed files with 25 additions and 0 deletions
25
README.md
25
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)
|
||||
|
|
BIN
screenshots.jpg
Normal file
BIN
screenshots.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 222 KiB |
Loading…
Reference in a new issue