update
This commit is contained in:
1 parent
0c36e4b6f4
commit
2b4c85aa7e
7 files changed
+41
-35
No files matched your search
+2
-1
@@ -14,7 +14,8 @@
|
|||||||
"**/account/pages/*.tsx",
|
"**/account/pages/*.tsx",
|
||||||
"**/login/Template.tsx",
|
"**/login/Template.tsx",
|
||||||
"**/account/Template.tsx",
|
"**/account/Template.tsx",
|
||||||
"**/login/UserProfileFormFields.tsx"
|
"**/login/UserProfileFormFields.tsx",
|
||||||
|
"KcApp.tsx"
|
||||||
],
|
],
|
||||||
"options": {
|
"options": {
|
||||||
"printWidth": 150
|
"printWidth": 150
|
||||||
|
|||||||
@@ -16,10 +16,10 @@
|
|||||||
html {
|
html {
|
||||||
animation: fadeToTransparent 500ms forwards ease-in;
|
animation: fadeToTransparent 500ms forwards ease-in;
|
||||||
}
|
}
|
||||||
body>.sb-preparing-docs {
|
body > .sb-preparing-docs {
|
||||||
visibility: hidden;
|
visibility: hidden;
|
||||||
}
|
}
|
||||||
body>.sb-preparing-story {
|
body > .sb-preparing-story {
|
||||||
visibility: hidden;
|
visibility: hidden;
|
||||||
}
|
}
|
||||||
</style>
|
</style>
|
||||||
@@ -2,8 +2,6 @@
|
|||||||
<i>🚀 <a href="https://keycloakify.dev">Keycloakify</a> v10 starter 🚀</i>
|
<i>🚀 <a href="https://keycloakify.dev">Keycloakify</a> v10 starter 🚀</i>
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
<img src="https://github.com/codegouvfr/keycloakify-starter/workflows/ci/badge.svg?branch=main">
|
|
||||||
<br/>
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
This starter is based on Vite. There is also [a Webpack based starter](https://github.com/keycloakify/keycloakify-starter-cra).
|
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
|
```bash
|
||||||
git clone https://github.com/keycloakify/keycloakify-starter
|
git clone https://github.com/keycloakify/keycloakify-starter
|
||||||
cd keycloakify-starter
|
cd keycloakify-starter
|
||||||
yarn install
|
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
|
# Storybook
|
||||||
@@ -34,8 +33,8 @@ npx keycloakify start-keycloak
|
|||||||
|
|
||||||
# Advanced customization
|
# Advanced customization
|
||||||
|
|
||||||
The starter only enables you to implement CSS level customization. To take full ownership
|
The starter only enables you to implement CSS level customization. To take full ownership
|
||||||
of some pages use the command:
|
of some pages use the command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx keycloakify eject-page
|
npx keycloakify eject-page
|
||||||
@@ -43,21 +42,25 @@ npx keycloakify eject-page
|
|||||||
|
|
||||||
# GitHub Actions
|
# 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).
|
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
|
# Removing the account theme
|
||||||
|
|
||||||
If you don't need to customize [the account theme pages](https://storybook.keycloakify.dev/?path=/story/account-account--default).
|
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.
|
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
|
# Email theme
|
||||||
|
|
||||||
Keycloakify lets you bundle an email theme however customization can't be made with React yet.
|
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
|
```bash
|
||||||
npx keycloakify initialize-email-theme
|
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
Reference in new issue
Block a user