7c9a87bc86
Change-Id: I7d82f728de0e503d4834f6815bde000c7a0204a3
37 lines
1.0 KiB
Markdown
37 lines
1.0 KiB
Markdown
[![Build Status](https://travis-ci.org/Awesome-Technologies/synapse-admin.svg?branch=master)](https://travis-ci.org/Awesome-Technologies/synapse-admin)
|
|
|
|
# Synapse admin ui
|
|
|
|
This project is built using [react-admin](https://marmelab.com/react-admin/).
|
|
|
|
It needs at least Synapse v1.18.0 for all functions to work as expected!
|
|
|
|
## 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)
|
|
|
|
## Development
|
|
|
|
- Use `yarn test` to run all style, lint and unit tests
|
|
- Use `yarn fix` to fix the coding style
|