GitHubStorybookStarter projectKeycloak as a service

🔩Keycloakify in my App

Collocating your App and your frontend code

A Keycloakify theme do not need to be a standalone project. Under certain conditions you can collocate your React app and your Keycloak theme. This enable to design the Keycloak user facing pages like if they where any other page of your project. (it's what's implemented in the starter project).

Currently you can only collocate your Keycloak theme with WebPack SPAs. Typically, create-react-app projects. It's not the case of your project? Don't worry! You can still use Keycloakify but your theme will need to be a standalone project. Just follow the instructions to make the starter project standalone.

We are working toward making Keycloakify agnostic to the project it's colocated with. This will enable collocation with Vite, Next, Gatsby... Follow the progress.

Before moving on and setting up Keycloakify in your project, first, mess around with the starter project to familiarize yourself with Keycloakify.

Once you think you are ready to move on:

yarn add keycloakify

add the following script

package.json
{
  "scripts": {
     ...
     "prepare": "copy-keycloak-resources-to-public", //This is only for beeing able to test the theme locally in storybook or with an explicit mockPageId
     "build-keycloak-theme": "yarn build && keycloakify"
  }
}

Git ignore the keycloak build directory:

.gitignore
...
/build_keycloak

That's it. You can build your App as a Keycloak theme with yarn build-keycloak-theme Reproduce the directory structure of the starter project.

You can eject pages using the npx eject-keycloak-page command.

You might now want to have a look at the available build options:

📖Build options
PreviousQuick startNextEmail customization