From 1ae29ab40ddae3125d9f8bc31b32c33c549acabd Mon Sep 17 00:00:00 2001 From: Stan Silvert Date: Mon, 10 Aug 2020 13:17:23 -0400 Subject: [PATCH] Add instructions to readme --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 816faec1f6..f7e87adb06 100644 --- a/README.md +++ b/README.md @@ -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 -1. Start keycloak - * from source: +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 + * Download Keycloak server from [https://www.keycloak.org/downloads]() + * Start Keycloak server like this from the bin directory: ```bash - $> cd - $> 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