keycloak-theme/README.md

🚀 Keycloakify v10 starter 🚀

This starter is based on Vite. There is also a Webpack based starter.

Quick start

git clone https://github.com/keycloakify/keycloakify-starter
cd keycloakify-starter
yarn install 
yarn build-keycloak-theme # Build the keycloak theme, generate the .jar file to be imported in Keycloak

Storybook

npx keycloakify add-story # Select the pages you want to add stories for
yarn storybook # Start Storybook

Test in a real Keycloak environment

Test your theme in a local Keycloak docker container.

npx keycloakify start-keycloak

Advanced customization

The starter only enables you to implement CSS level customization. To take full ownership of some pages use the command:

npx keycloakify eject-page