TomaszKK 88bd48c1f7 add final app 2 ماه پیش
..
.github 88bd48c1f7 add final app 2 ماه پیش
.storybook 88bd48c1f7 add final app 2 ماه پیش
public 88bd48c1f7 add final app 2 ماه پیش
src 88bd48c1f7 add final app 2 ماه پیش
.gitignore 88bd48c1f7 add final app 2 ماه پیش
.prettierignore 88bd48c1f7 add final app 2 ماه پیش
.prettierrc.json 88bd48c1f7 add final app 2 ماه پیش
LICENSE 88bd48c1f7 add final app 2 ماه پیش
README.md 88bd48c1f7 add final app 2 ماه پیش
components.json 88bd48c1f7 add final app 2 ماه پیش
eslint.config.js 88bd48c1f7 add final app 2 ماه پیش
index.html 88bd48c1f7 add final app 2 ماه پیش
package-lock.json 88bd48c1f7 add final app 2 ماه پیش
package.json 88bd48c1f7 add final app 2 ماه پیش
postcss.config.js 88bd48c1f7 add final app 2 ماه پیش
tailwind.config.js 88bd48c1f7 add final app 2 ماه پیش
tsconfig.json 88bd48c1f7 add final app 2 ماه پیش
tsconfig.node.json 88bd48c1f7 add final app 2 ماه پیش
vite.config.ts 88bd48c1f7 add final app 2 ماه پیش
yarn.lock 88bd48c1f7 add final app 2 ماه پیش

README.md

🚀 Keycloakify v11 starter 🚀

Quick start

git clone https://github.com/keycloakify/keycloakify-starter
cd keycloakify-starter
yarn install # Or use an other package manager, just be sure to delete the yarn.lock if you use another package manager.

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.

Initializing the account theme

npx keycloakify initialize-account-theme

Initializing the email theme

npx keycloakify initialize-email-theme

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.