Add instructions to readme

This commit is contained in:
Stan Silvert 2020-08-10 13:17:23 -04:00
parent 60075db602
commit 1ae29ab40d

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 1. Start keycloak
* from source: * Download Keycloak server from [https://www.keycloak.org/downloads]()
* Start Keycloak server like this from the bin directory:
```bash ```bash
$> cd <keycloak src directory> $> standalone -Djboss.socket.binding.port-offset=100
$> cd testsuite/utils
$> mvn exec:java -Dexec.mainClass="org.keycloak.testsuite.KeycloakServer" -Dkeycloak.port=8180
``` ```
* Download and run * or download and run with one command
```bash ```bash
$> ./start.js $> ./start.js
``` ```
1. Add the client 1. Add the client
* like this: * like this:
![realm settings](./realm-settings.png "Realm Settings") ![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: 1. Install dependecies and run:
```bash ```bash