PenguinOwl/keycloak-theme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update

Browse Source
This commit is contained in:
Joseph Garrone
2024-06-07 05:20:57 +02:00
parent 0c36e4b6f4
commit 2b4c85aa7e
7 changed files with 41 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -2,8 +2,6 @@
<i>🚀 <a href="https://keycloakify.dev">Keycloakify</a> v10 starter 🚀</i>
<br/>
<br/>
<img src="https://github.com/codegouvfr/keycloakify-starter/workflows/ci/badge.svg?branch=main">
<br/>
</p>
This starter is based on Vite. There is also [a Webpack based starter](https://github.com/keycloakify/keycloakify-starter-cra).
@ -13,8 +11,9 @@ 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
yarn build-keycloak-theme # Build the keycloak theme, generate the .jar file to be imported in Keycloak
yarn install
# Generate the dist_keycloak/.jar file that you can import in Keycloak
yarn build-keycloak-theme
```
# Storybook
@ -34,8 +33,8 @@ npx keycloakify start-keycloak
# Advanced customization
The starter only enables you to implement CSS level customization. To take full ownership
of some pages use the command:
The starter only enables you to implement CSS level customization. To take full ownership
of some pages use the command:
```bash
npx keycloakify eject-page
@ -43,21 +42,25 @@ npx keycloakify eject-page
# GitHub Actions
The starter comes with a GitHub Actions workflow that builds the theme and publishes
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`.
# Removing the account theme
If you don't need to customize [the account theme pages](https://storybook.keycloakify.dev/?path=/story/account-account--default).
You can remove the `src/account` directory and make the necessary changes in `src/main.tsx` and `src/vite-env.d.ts`.
You can remove the `src/account` directory.
This will significantly reduce the the size of the jar and the build time.
Don't forget to update `src/main.tsx` and `src/vite-env.d.ts`.
# Email theme
Keycloakify lets you bundle an email theme however customization can't be made with React yet.
It's just a regular Keycloak theme.
To initialize the email theme run:
```bash
npx keycloakify initialize-email-theme
```