2025-02-03 16:08:06 +07:00
|
|
|
<p align="center">
|
|
|
|
<i>🚀 <a href="https://keycloakify.dev">Angular + Vite Keycloakify</a> v11 starter 🚀</i>
|
|
|
|
<br/>
|
|
|
|
<br/>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
This starter is based on Vite and Angular. There is also [a Webpack based starter](https://github.com/keycloakify/keycloakify-starter-angular).
|
|
|
|
|
|
|
|
# Quick start
|
|
|
|
|
|
|
|
```bash
|
|
|
|
git clone https://github.com/keycloakify/keycloakify-starter-angular-vite
|
|
|
|
cd keycloakify-starter-angular-vite
|
|
|
|
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/targeting-specific-keycloak-versions).
|
|
|
|
|
|
|
|
# Initializing the account theme
|
|
|
|
|
|
|
|
```bash
|
|
|
|
npx keycloakify initialize-account-theme
|
|
|
|
```
|
|
|
|
|
|
|
|
# Initializing the email theme
|
|
|
|
|
|
|
|
```bash
|
|
|
|
npx keycloakify initialize-email-theme
|
|
|
|
```
|
2025-02-03 16:16:25 +07:00
|
|
|
|
|
|
|
# Deploy the theme into Keycloak on Docker Container
|
|
|
|
```bash
|
|
|
|
docker cp ./dist_keycloak/keycloak-theme-for-kc-all-other-versions.jar <container_id>:/opt/keycloak/providers
|
|
|
|
# then restart the container
|
|
|
|
```
|