Add custom login page

README.md

@@ -4,26 +4,23 @@
 
 A starter/demo project for [Keycloakify](https://keycloakify.dev)
 
-# ⚠️ Please read the two following notices ⚠️
+# ⚠️ Please read the two following notice ⚠️
 
-> This starter is for **Component-level customization**, if you only want to customize **the page at the CSS level**
+> If you are only looking to create a theme and don't care about integrating it into an React app there
-> heads over to [keycloakify-starter](https://github.com/garronej/keycloakify-starter).
-
-> If you are only looking to create a theme and don't care about integrating it into a React app there
 > are a lot of things that you can remove from this starter. [Please read this](#standalone-keycloak-theme).
 
 # Quick start
 
 ```bash
 yarn
-yarn keycloak # Build the theme one time (some assets will be copied to 
+yarn build-keycloak-theme # Build the theme one time (some assets will be copied to 
               # public/keycloak_static, they are needed to dev your page outside of Keycloak)
 yarn start # See the Hello World app
 # Uncomment line 15 of src/keycloakTheme/kcContext, reload https://localhost:3000
 # You can now develop your Login pages.
 
 # Think your theme is ready? Run
-yarn keycloak
+yarn build-keycloak-theme
 # Read the instruction printed on the console to see how to test
 # your theme on a real Keycloak instance.
 ```
@@ -66,11 +63,11 @@ More info on the `--external-assets` build option [here](https://docs.keycloakif
 # Docker
 
 ```bash
-docker build -f Dockerfile -t garronej/keycloakify-advanced-starter:test .
+docker build -f Dockerfile -t codegouvfr/keycloakify-starter:test .
 #OR (to reproduce how the image is built in the ci workflow):
-yarn && yarn build && tar -cvf build.tar ./build && docker build -f Dockerfile.ci -t garronej/keycloakify-advanced-starter:test . && rm build.tar
+yarn && yarn build && tar -cvf build.tar ./build && docker build -f Dockerfile.ci -t codegouvfr/keycloakify-starter:test . && rm build.tar
 
-docker run -it -dp 8083:80 garronej/keycloakify-advanced-starter:test
+docker run -it -dp 8083:80 garronej/keycloakify-starter:test
 ```
 
 ## DockerHub credentials

package.json

@@ -1,16 +1,16 @@
 {
-    "name": "keycloakify-advanced-starter",
+    "name": "keycloakify-starter",
-    "homepage": "https://demo-app-advanced.keycloakify.dev",
+    "homepage": "https://starter.keycloakify.dev",
     "version": "1.0.8",
     "description": "A starter/demo project for keycloakify",
     "repository": {
         "type": "git",
-        "url": "git://github.com/garronej/keycloakify-advanced-starter.git"
+        "url": "git://github.com/codegouvfr/keycloakify-starter.git"
     },
     "scripts": {
         "start": "react-scripts start",
         "build": "react-scripts build",
-        "keycloak": "yarn build && keycloakify",
+        "build-keycloak-theme": "yarn build && keycloakify",
         "download-builtin-keycloak-theme": "download-builtin-keycloak-theme 15.0.2"
     },
     "keycloakify": {

src/keycloakTheme/KcApp.tsx

@@ -3,15 +3,16 @@ import { lazy, Suspense } from "react";
 import type { KcContext } from "./kcContext";
 import { useI18n } from "./i18n";
 import Fallback, { defaultKcProps, type KcProps, type PageProps } from "keycloakify";
-// Here we have overloaded the default template, however you could use the default one with:  
-//import Template from "keycloakify/lib/Template";
 import Template from "./Template";
+import DefaultTemplate from "keycloakify/lib/Template";
 
-const Login = lazy(() => import("keycloakify/lib/pages/Login"));
+const Login = lazy(()=> import("./pages/Login"));
+// If you can, favor register-user-profile.ftl over register.ftl, see: https://docs.keycloakify.dev/realtime-input-validation
 const Register = lazy(() => import("./pages/Register"));
 const Terms = lazy(() => import("./pages/Terms"));
 const MyExtraPage1 = lazy(() => import("./pages/MyExtraPage1"));
 const MyExtraPage2 = lazy(() => import("./pages/MyExtraPage2"));
+const Info = lazy(()=> import("keycloakify/lib/pages/Info"));
 
 // This is like editing the theme.properties 
 // https://github.com/keycloak/keycloak/blob/11.0.3/themes/src/main/resources/theme/keycloak/login/theme.properties
@@ -35,7 +36,10 @@ export default function App(props: { kcContext: KcContext; }) {
 
     const pageProps: Omit<PageProps<any, typeof i18n>, "kcContext"> = {
         i18n,
+        // Here we have overloaded the default template, however you could use the default one with:  
+        //Template: DefaultTemplate,
         Template,
+        // Wether or not we should download the CSS and JS resources that comes with the default Keycloak theme.  
         doFetchDefaultThemeResources: true,
         ...kcProps,
     };
@@ -49,6 +53,8 @@ export default function App(props: { kcContext: KcContext; }) {
                     case "terms.ftl": return <Terms {...{ kcContext, ...pageProps }} />;
                     case "my-extra-page-1.ftl": return <MyExtraPage1 {...{ kcContext, ...pageProps }} />;
                     case "my-extra-page-2.ftl": return <MyExtraPage2 {...{ kcContext, ...pageProps }} />;
+                    // We choose to use the default Template for the Info page and to download the theme resources.
+                    case "info.ftl": return <Info {...{ kcContext, ...pageProps}} Template={DefaultTemplate} doFetchDefaultThemeResources={true} />;
                     default: return <Fallback {...{ kcContext, ...pageProps }} />;
                 }
             })()}