Update README.md

Signed-off-by: Joseph Garrone <joseph.garrone.gj@gmail.com>
This commit is contained in:
Joseph Garrone 2023-03-04 15:46:33 +01:00 committed by GitHub
parent ae6bcd89d5
commit 18ed86f1e9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -4,8 +4,11 @@
A starter/demo project for [Keycloakify](https://keycloakify.dev) A starter/demo project for [Keycloakify](https://keycloakify.dev)
> NOTE: If you are only looking to create a theme and don't care about integrating it into an React app there # Introduction
> are a lot of things that you can remove from this starter. [Please read this](#standalone-keycloak-theme).
This repo constitutes an easily reusable setup for a standalone Keycloak theme project OR for a SPA React App that generates a
Keycloak theme that goes along with it.
If you are only looking to create a theme (an not a theme + an App) there are a lot of things that you can remove from this starter: [Please read this](#standalone-keycloak-theme).
# Quick start # Quick start
@ -23,11 +26,6 @@ yarn build-keycloak-theme
# your theme on a real Keycloak instance. # your theme on a real Keycloak instance.
``` ```
# Introduction
This repo constitutes an easily reusable CI setup for SPA React App that generates Keycloaks's theme
using [keycloakify](https://github.com/InseeFrLab/keycloakify).
# The CI workflow # The CI workflow
- You need to manually allow GitHub Action to push on your REPO. For this reason the initial setup will fail. You need to enabled permission and re-run failed job: [see video](https://user-images.githubusercontent.com/6702424/213480604-0aac0ea7-487f-491d-94ae-df245b2c7ee8.mov). - You need to manually allow GitHub Action to push on your REPO. For this reason the initial setup will fail. You need to enabled permission and re-run failed job: [see video](https://user-images.githubusercontent.com/6702424/213480604-0aac0ea7-487f-491d-94ae-df245b2c7ee8.mov).