Go to file
Joseph Garrone d3a9a41dba Update
2024-06-16 18:40:28 +02:00
.devcontainer Migrate to Keycloakify v10 2024-06-06 05:26:06 +02:00
.github/workflows Update 2024-06-16 18:40:28 +02:00
.storybook Remove storybook addons 2024-06-09 15:13:39 +02:00
public Don't use SspCloud as terms placeholder 2024-06-06 06:39:16 +02:00
src Fix inconsistency 2024-06-11 21:10:47 +02:00
.eslintrc.cjs Migrate to Keycloakify v10 2024-06-06 05:26:06 +02:00
.gitignore Working build 2024-02-12 02:00:54 +01:00
.prettierignore Migrate to Keycloakify v10 2024-06-06 05:26:06 +02:00
.prettierrc.json update 2024-06-07 05:20:57 +02:00
index.html Migrate to Keycloakify v10 2024-06-06 05:26:06 +02:00
LICENSE Initial commit 2022-09-06 19:22:23 +02:00
package.json Update keycloakify 2024-06-16 18:09:23 +02:00
README.md Update readme 2024-06-16 18:08:59 +02:00
tsconfig.json Migrate to Keycloakify v10 2024-06-06 05:26:06 +02:00
tsconfig.node.json Migrate to Keycloakify v10 2024-06-06 05:26:06 +02:00
vite.config.ts Use vanilla vite config 2024-06-16 02:36:06 +02:00
yarn.lock Update keycloakify 2024-06-16 18:09:23 +02:00

🚀 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

NOTE: This setup uses yarn as the default but you can use any package manager you like.

Testing the theme locally

Documentation

How to customize the theme

Documentation

Building the theme

npm run build-keycloak-theme

Note that by default Keycloakify generates multiple .jar files for different versions of Keycloak.
You can customize this behavior, see documentation here.

GitHub Actions

The starter comes with a generic GitHub Actions workflow that builds the theme and publishes the jars as GitHub releases artifacts.
To release a new version just update the package.json version and push.

To enable the workflow go to your fork of this repository on GitHub then navigate to: Settings > Actions > Workflow permissions, select Read and write permissions.