Merge pull request #16 from ssilvert/00014-fix-readme

Add instructions to readme
This commit is contained in:
Stan Silvert 2020-08-10 13:47:41 -04:00 committed by GitHub
commit ca992b14d9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,22 +1,24 @@
# Keycloak Admin Console
# Keycloak Admin Console V2
This project is the next generation of the Keycloak Administration Console. It is written with React and PatternFly 4.
### Build / Run
### Development Instructions
For developemnt on this project you will need a running Keycloak server listening on port 8180. You will also need [yarn installed on your local machine.](https://classic.yarnpkg.com)
1. Start keycloak
* from source:
* Download Keycloak server from [https://www.keycloak.org/downloads]()
* Start Keycloak server like this from the bin directory:
```bash
$> cd <keycloak src directory>
$> cd testsuite/utils
$> mvn exec:java -Dexec.mainClass="org.keycloak.testsuite.KeycloakServer" -Dkeycloak.port=8180
$> standalone -Djboss.socket.binding.port-offset=100
```
* Download and run
* or download and run with one command
```bash
$> ./start.js
```
1. Add the client
* like this:
![realm settings](./realm-settings.png "Realm Settings")
* or import `security-admin-console-v2.json`
* or click on the "Select file" button and import `security-admin-console-v2.json`
1. Install dependecies and run:
```bash