From a795bc0e3a4558d93dc04cf8c001ef7b93e44123 Mon Sep 17 00:00:00 2001 From: Stan Silvert Date: Tue, 19 Mar 2019 15:13:15 -0400 Subject: [PATCH] KEYCLOAK-9659: Create readme build instructions for new account console. --- .../account/resources/README.md | 50 +++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 themes/src/main/resources/theme/keycloak-preview/account/resources/README.md diff --git a/themes/src/main/resources/theme/keycloak-preview/account/resources/README.md b/themes/src/main/resources/theme/keycloak-preview/account/resources/README.md new file mode 100644 index 0000000000..5b97b09110 --- /dev/null +++ b/themes/src/main/resources/theme/keycloak-preview/account/resources/README.md @@ -0,0 +1,50 @@ +New Account Console +======== + +The new Account Console uses PatternFly 4 and React. + +Here is what you need to know in order to do development on the new console. + + +Building +-------- +First, you must install node and npm. Then run install. + +`npm install` + +To build and lint the application: + +`npm run build` + +If your IDE doesn't handle dynamic TypeScript transpilation, use the watch script: + +`npm run build:watch` + +If you want to run lint by itself**: + +`npm run lint` + +** Please lint the code and fix any errors or warnings before doing a commit. + +Edit standalone.xml +-------- +Your standalone.xml should have the following set in the keycloak subsystem: + +```xml + + -1 + false + false + path_to_keycloak_dev/keycloak/themes/src/main/resources/theme + +``` + +Running +-------- +You should run the Keycloak server with the following system properties: + +`standalone -Dkeycloak.profile.feature.account_api=enabled -Dkeycloak.profile.feature.account2=enabled` + +Log in to the admin console. Go to Realm Settings --> Themes. Then set account theme to "keycloak-preview". + +Now when you go to account management you should see the new React/PF4 version. \ No newline at end of file