Update how terms

This commit is contained in:
Joseph Garrone
2024-06-21 02:31:13 +02:00
parent 5c71c15c6d
commit 3e8981c7eb
4 changed files with 624 additions and 251 deletions

View File

@ -11,12 +11,12 @@ This starter is based on Vite. There is also [a Webpack based starter](https://g
```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.
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)
[Documentation](https://docs.keycloakify.dev/v/v10/testing-your-theme)
# How to customize the theme
@ -25,16 +25,17 @@ yarn install # Or use an other package manager, just be sure to delete the yarn.
# 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))
- 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).
You can customize this behavior, see documentation [here](https://docs.keycloakify.dev/v/v10/targetting-specific-keycloak-versions).
# GitHub Actions
@ -44,4 +45,3 @@ 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`.