48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
<p align="center">
|
|
<i>🚀 <a href="https://keycloakify.dev">Keycloakify</a> v10 starter 🚀</i>
|
|
<br/>
|
|
<br/>
|
|
</p>
|
|
|
|
This starter is based on Vite. There is also [a Webpack based starter](https://github.com/keycloakify/keycloakify-starter-webpack).
|
|
|
|
# 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 do.
|
|
```
|
|
|
|
# Testing the theme locally
|
|
|
|
[Documentation](https://docs.keycloakify.dev/v/v10/testing-your-theme)
|
|
|
|
# How to customize the theme
|
|
|
|
[Documentation](https://docs.keycloakify.dev/v/v10/customization-strategies)
|
|
|
|
# Building the theme
|
|
|
|
You need to have Maven installed to build the theme (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/v/v10/targetting-specific-keycloak-versions).
|
|
|
|
# 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/v7.1.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`.
|
|
|