Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.96 KB

README.md

File metadata and controls

56 lines (38 loc) · 1.96 KB
Raw

🚀 Keycloakify v11 starter 🚀

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

Quick start

git clone https://github.com/keycloakify/keycloakify-starter-webpack
cd keycloakify-starter-webpack
yarn install # Or use pnpm or bun (but not npm), just be sure to delete the yarn.lock if you do.

Testing the theme locally

Documentation

How to customize the theme

Documentation

Building the theme

You need to have Maven installed to build the theme (Maven >= 3.1.1, Java >= 7).
The mvn command must be in the $PATH.

  • On macOS: brew install maven
  • On Debian/Ubuntu: sudo apt-get install maven
  • On Windows: choco install openjdk and choco install maven (Or download from here)
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.

Ejecting from Create React App

This setup is based on Create React App however you can eject it into a custom Webpack setup with:

npx react-scripts eject