This commit is contained in:
Joseph Garrone committed 2024-06-07 05:20:57 +02:00
1 parent 0c36e4b6f4
commit 2b4c85aa7e
7 files changed
+37 -31

No files matched your search

+2 -1
View File
@@ -14,7 +14,8 @@
"**/account/pages/*.tsx",
"**/login/Template.tsx",
"**/account/Template.tsx",
"**/login/UserProfileFormFields.tsx"
"**/login/UserProfileFormFields.tsx",
"KcApp.tsx"
],
"options": {
"printWidth": 150
+2 -2
View File
@@ -16,10 +16,10 @@
html {
animation: fadeToTransparent 500ms forwards ease-in;
}
body>.sb-preparing-docs {
body > .sb-preparing-docs {
visibility: hidden;
}
body>.sb-preparing-story {
body > .sb-preparing-story {
visibility: hidden;
}
</style>
+10 -7
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).
@@ -14,7 +12,8 @@ This starter is based on Vite. There is also [a Webpack based starter](https://g
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
# Generate the dist_keycloak/.jar file that you can import in Keycloak
yarn build-keycloak-theme
```
# Storybook
@@ -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
```
Loaded 3 of 7 files, more files were not shown because too many files have changed in this diff. Show more