Update README
This commit is contained in:
parent
e379043ed2
commit
9eac0dbca6
43
README.md
43
README.md
@ -33,6 +33,15 @@ yarn start # See the Hello World app
|
||||
yarn build-keycloak-theme
|
||||
# Read the instruction printed on the console to see how to test
|
||||
# your theme on a real Keycloak instance.
|
||||
|
||||
# For customizing other pages at the component level
|
||||
npx eject-keycloak-page # Then select the page you want
|
||||
|
||||
# For initializing your email theme
|
||||
npx initialize-email-theme
|
||||
|
||||
# For downloading the default theme
|
||||
npx download-builtin-keycloak-theme
|
||||
```
|
||||
|
||||
# The CI workflow
|
||||
@ -94,22 +103,36 @@ rm -r src/keycloak-theme
|
||||
|
||||
cat << EOF > src/index.tsx
|
||||
import { createRoot } from "react-dom/client";
|
||||
import { StrictMode } from "react";
|
||||
import { kcContext } from "./kcContext";
|
||||
import KcApp from "./KcApp";
|
||||
import { StrictMode, lazy, Suspense } from "react";
|
||||
import { kcContext as kcLoginThemeContext } from "./login/kcContext";
|
||||
import { kcContext as kcAccountThemeContext } from "./account/kcContext";
|
||||
|
||||
const KcLoginThemeApp = lazy(() => import("./login/KcApp"));
|
||||
const KcAccountThemeApp = lazy(() => import("./account/KcApp"));
|
||||
|
||||
createRoot(document.getElementById("root")!).render(
|
||||
<StrictMode>
|
||||
<Suspense>
|
||||
{(()=>{
|
||||
|
||||
if( kcLoginThemeContext !== undefined ){
|
||||
return <KcLoginThemeApp kcContext={kcLoginThemeContext} />;
|
||||
}
|
||||
|
||||
if( kcAccountThemeContext !== undefined ){
|
||||
return <KcAccountThemeApp kcContext={kcAccountThemeContext} />;
|
||||
}
|
||||
|
||||
if( kcContext === undefined ){
|
||||
throw new Error(
|
||||
"This app is a Keycloak theme" +
|
||||
"It isn't meant to be deployed outside of Keycloak"
|
||||
);
|
||||
}
|
||||
|
||||
createRoot(document.getElementById("root")!).render(
|
||||
<StrictMode>
|
||||
<KcApp kcContext={kcContext} />
|
||||
})()}
|
||||
</Suspense>
|
||||
</StrictMode>
|
||||
);
|
||||
|
||||
EOF
|
||||
|
||||
rm .dockerignore Dockerfile Dockerfile.ci nginx.conf
|
||||
@ -190,7 +213,7 @@ jobs:
|
||||
prerelease: \${{ needs.check_if_version_upgraded.outputs.is_release_beta == 'true' }}
|
||||
env:
|
||||
GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
|
||||
EOF
|
||||
# - run: npx -y -p gh-pages@3.0.0 gh-pages -u "github-actions-bot <actions@github.com>" -d storybook-static --dest storybook --add
|
||||
```
|
||||
|
||||
You can also remove `jwt-decode`, `keycloak-js` and `tsafe from your dependencies.
|
||||
You can also remove `jwt-decode`, `keycloak-js`, `powerhooks` and `tsafe` from your dependencies.
|
||||
|
@ -5,13 +5,15 @@ import { createOidcClientProvider, useOidcClient } from "./oidc";
|
||||
import { addFooToQueryParams, addBarToQueryParams } from "../keycloak-theme/login/valuesTransferredOverUrl";
|
||||
import jwt_decode from "jwt-decode";
|
||||
|
||||
const keycloakUrl = "https://auth.code.gouv.fr"
|
||||
//On older Keycloak version you need the /auth (e.g: http://localhost:8080/auth)
|
||||
//On newer version you must remove it (e.g: http://localhost:8080 )
|
||||
const keycloakUrl = "https://auth.code.gouv.fr/auth";
|
||||
const keycloakRealm = "keycloakify";
|
||||
|
||||
const { OidcClientProvider } = createOidcClientProvider({
|
||||
url: `${keycloakUrl}/auth`,
|
||||
url: keycloakUrl,
|
||||
realm: keycloakRealm,
|
||||
clientId: "starter",
|
||||
clientId: "myclient",
|
||||
//This function will be called just before redirecting,
|
||||
//it should return the current langue.
|
||||
//kcContext.locale.currentLanguageTag will be what this function returned just before redirecting.
|
||||
|
Loading…
Reference in New Issue
Block a user