Skip to content

Latest commit

聽

History

History
58 lines (37 loc) 路 3.53 KB

README.md

File metadata and controls

58 lines (37 loc) 路 3.53 KB
Raw
description
What you'll need

馃弫 Requirements

{% hint style="warning" %} This tool will only run natively on Linux and Mac OS.

Windows users will haver to use it via WSL. More info here. {% endhint %}

{% hint style="success" %} This tool will be maintained to stay compatible with every Keycloak version starting from Keycloak Version 11.

However, the default pages you will get (before you customize them) will always be the ones of Keycloak v11.0.3. {% endhint %}

Supported Keycloak version

See versions confirmed working

Supported React frameworks

{% hint style="success" %} If you want to make your life easy use create-react-app and start from the template repo. {% endhint %}

Utility that needs to be installed

  • mvn (Maven), rm, mkdir, curl, unzip are assumed to be available.
  • docker must be up and running when running start_keycloak_testing_container.sh (Instructions provided after running yarn keycloak).

This tool assumes you are bundling your app with Webpack (tested with the versions that ships with CRA v4.44.2 and v5.0.0) . It assumes there is a build/ directory at the root of your react project directory containing a index.html file and a build/static/ directory generated by webpack.

For more information see this issue.

All this is defaults with create-react-app (tested with 5.0.0, 4.0.3)

  • mvn (Maven), rm, mkdir, curl, unzip are assumed to be available.
  • docker must be up and running when running start_keycloak_testing_container.sh (Instructions provided after running yarn keycloak).

My framework doesn鈥檛 seem to be supported, what can I do?

Currently Keycloakify is only compatible with SPA React apps. It doesn鈥檛 mean that you can't use Keycloakify if you are using Next.js, Express or any other framework that involves a server but your Keycloak theme will need to be a standalone project.
Find specific instructions about how to get started here.

To share your styles between your main app and your login pages you will need to externalize your design system by making it a separate module. Checkout ts_ci, it can help with that (example with our design system).