History

Erik Jan de Wit f088b0009c initial ui for organizations (#29643 ) * initial screen Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * more screens Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * added members tab Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * added the backend Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * added member add / invite models Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * initial version of the identity provider section Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * add link and unlink providers Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * small fix Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * PR comments Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * Do not validate broker domain when the domain is an empty string Closes #29759 Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * added filter and value Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * added test Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * added first name last name Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * refresh menu when realm organization is changed Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * changed to record Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * changed to form data Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * fixed lint error Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * Changing name of invitation parameters Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * Chancing name of parameters on the client Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * Enable organization at the realm before running tests Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * Domain help message Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * Handling model validation errors when creating organizations Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * Message key for organizationDetails Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * Do not change kc.org attribute on group Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * add realm into the context Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * tests Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * Changing button in invitation model to use Send instead of Save Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * Better message when validating the organization domain Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * Fixing compilation error after rebase Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * fixed test Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * removed wait as it no longer required and skip flacky test Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * skip tests that are flaky Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> * stabilize user create test Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> --------- Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com> Signed-off-by: Pedro Igor <pigor.craveiro@gmail.com> Co-authored-by: Pedro Igor <pigor.craveiro@gmail.com>		2024-05-29 14:34:02 +02:00
..
cypress	initial ui for organizations (#29643 )	2024-05-29 14:34:02 +02:00
maven-resources	initial ui for organizations (#29643 )	2024-05-29 14:34:02 +02:00
maven-resources-community/theme/keycloak.v2/admin/messages	Translated using Weblate (Georgian) (#29588 )	2024-05-23 14:42:55 -04:00
public	Upgrade admin and account console to PatternFly 5 (#28196 )	2024-04-05 16:37:05 +02:00
src	initial ui for organizations (#29643 )	2024-05-29 14:34:02 +02:00
cypress.config.js	Remove the video file only if it exists	2024-05-15 15:07:22 +02:00
index.html	Add landmark element for loading state for consoles (#26037 )	2024-01-09 15:41:26 +00:00
package.json	Bump @types/react from 18.3.2 to 18.3.3	2024-05-27 09:55:28 +02:00
pom.xml	use context for adminClient (#28693 )	2024-05-08 10:23:43 +02:00
README.md	Move all JavaScript projects into single PNPM workspace (#24537 )	2024-04-02 16:14:58 +02:00
tsconfig.json	Move ESLint configuration to project root (#28639 )	2024-04-12 08:34:18 +00:00
tsconfig.node.json	Rework project structure so it matches the main repo	2023-03-07 11:55:19 +01:00
vite.config.ts	Fix incorrect branching for some authentication flow diagrams. Fixes #28479 (#28480 )	2024-05-06 13:21:32 +02:00

README.md

Keycloak Admin UI

This project is the next generation of the Keycloak Administration UI. It is written with React and PatternFly 4 and uses Vite and Cypress.

Development

Prerequisites

Make sure that you have Node.js version 18 (or later) installed on your system. If you do not have Node.js installed we recommend using Node Version Manager to install it.

You can find out which version of Node.js you are using by running the following command:

node --version

In order to run the Keycloak server you will also have to install the Java Development Kit (JDK). We recommend that you use the same version of the JDK as required by the Keycloak server.

Running the Keycloak server

See the instructions in the Keycloak server app.

Running the development server

Now that the Keycloak sever is running it's time to run the development server for the Admin UI. This server is used to build the Admin UI in a manner that it can be iterated on quickly in a browser, using features such as Hot Module Replacement (HMR) and Fast Refresh.

To start the development server run the following command:

pnpm dev

Once the process of optimization is done your browser will automatically open your local host on port 8080. From here you will be redirected to the Keycloak server to authenticate, which you can do with the default credentials (admin/admin).

You can now start making changes to the source code, and they will be reflected in your browser.

Building as a Keycloak theme

If you want to build the application using Maven and produce a JAR that can be installed directly into Keycloak, check out the Keycloak theme documentation.

Linting

Every time you create a commit it should be automatically linted and formatted for you. It is also possible to trigger the linting manually:

pnpm lint

Integration testing with Cypress

This repository contains integration tests developed with the Cypress framework.

Prerequisites

Ensure the Keycloak and development server are running as outlined previously in this document.

Running the tests

You can run the tests using the interactive graphical user interface using the following command:

pnpm cy:open

Alternatively the tests can also run headless as follows:

pnpm cy:run

For more information about the Cypress command-line interface consult the documentation.

Project Structure

You can find information about the project structure in the official Cypress documentation. Read more about how to write tests