Keycloak Admin UI

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

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

First, ensure that all dependencies are installed locally using NPM by running:

npm install

After the dependencies are installed we can start the Keycloak server by running the following command:

npm run server:start

This will download the Nightly version of the Keycloak server and run it locally on port 8180. If a previously downloaded version was found in the server/ directory then that one will be used instead. If you want to download the latest Nightly version you can remove the server directory before running the command to start the server.

In order for the development version of the Admin UI to work you will have to import a custom client to the Keycloak server. This is only required during development as the development server for the Admin UI runs on a different port (more on that later).

Wait for the Keycloak server to be up and running and run the following command in a new terminal:

npm run server:import-client

You'll only have to run this command once, unless you remove the server directory or Keycloak server data.

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:

npm run 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 username and password (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:

npm run 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:

npm run cy:open

Alternatively the tests can also run headless as follows:

npm run 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

Data processing

Red Hat may process information including business contact information and code contributions as part of its participation in the project, data is processed in accordance with Red Hat Privacy Statement.

License

• Apache License, Version 2.0