https://github.com/keycloakify/keycloakify-starter
🔑 Keycloakify Projects Starter Template
https://github.com/keycloakify/keycloakify-starter
Last synced: 8 months ago
JSON representation
🔑 Keycloakify Projects Starter Template
- Host: GitHub
- URL: https://github.com/keycloakify/keycloakify-starter
- Owner: keycloakify
- License: mit
- Created: 2022-09-06T17:19:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-27T01:05:52.000Z (10 months ago)
- Last Synced: 2025-10-20T10:59:31.229Z (8 months ago)
- Language: TypeScript
- Homepage: http://keycloakify.dev
- Size: 15.9 MB
- Stars: 318
- Watchers: 10
- Forks: 335
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🚀 Keycloakify v11 starter 🚀
# Quick start
```bash
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](https://docs.keycloakify.dev/testing-your-theme)
# How to customize the theme
[Documentation](https://docs.keycloakify.dev/customization-strategies)
# Building the theme
You need to have [Maven](https://maven.apache.org/) 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](https://maven.apache.org/download.cgi))
```bash
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](https://docs.keycloakify.dev/features/compiler-options/keycloakversiontargets).
# Initializing the account theme
```bash
npx keycloakify initialize-account-theme
```
# Initializing the email theme
```bash
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](https://github.com/keycloakify/keycloakify-starter/releases/tag/v10.0.0).
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`.