keycloak/js/apps/admin-ui/CONTRIBUTING.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 Playwright.

Development

Prerequisites

Make sure that you have Node.js version 24 (or later) installed on your system.

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.

In this mode the messages for translation will come directly from the messages.properties and the realm overrides will be ignored, this makes testing adding messages easier. But when you want to see the realm overrides instead, you can add the environment variable VITE_REALM_OVERRIDES=true to disable this behavior.

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 Playwright

This repository contains integration tests developed with the Playwright 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 Visual Studio Code plugin

Alternatively the tests can also run headless as follows:

pnpm test:integration

Running specific tests

You can execute specific individual tests as follows:

# f.e. pnpm test:integration -- test/clients/main.spec.ts
pnpm test:integration -- <path-to-the-test-or-name>

You can specify the full path or just the test file name.

Running Playwright UI

The Playwright UI provides an interactive environment for developing and debugging UI tests. Before proceeding, ensure the following prerequisites are met:

• The Keycloak server is running on http://localhost:8080.
• An admin user with login admin and password admin exists in the master realm.

Execute the following steps from the repository root.

1. Navigate to the Admin UI directory:

   cd apps/admin-ui
   

2. Install the Playwright browser binaries. This step is required once per local development environment:

   pnpm exec playwright install
   

3. Launch the Playwright interactive UI and run tests (Chromium):

   pnpm run test:integration -- --project=chromium --ui
   

After executing these steps, the Playwright Test Runner UI will open in a new window. You can select and run individual tests or test suites interactively. The test runner provides features such as viewing test results, debugging failed tests, and inspecting the browser state during test execution.