Keycloakify
GitHubHome
v5
  • Documentation
  • Release Notes & Upgrade Instructions
  • FAQ
v5
  • ๐ŸRequirements
  • ๐Ÿ‘จโ€๐Ÿ’ป๐Ÿ‘จ๐Ÿ’ป Quick start
  • ๐ŸงชDevelopment
  • ๐Ÿ“งEmail customization
  • โœ’๏ธTerms and conditions
  • โœ…Realtime input validation
  • โš ๏ธLimitations
  • ๐ŸŒ‰Context persistence
  • ๐ŸŒAdding i18n messages keys
  • โšกPerformance optimization
  • ๐Ÿ’‚Email domain acceptlist
  • ๐Ÿ›‘Keycloak error in log
  • ๐Ÿ’ŸContributing
Powered by GitBook
On this page
  • Seeing the result live
  • Testing in a real Keycloak instance

Was this helpful?

Edit on GitHub
Export as PDF

Development

Test and debug your theme

Previous๐Ÿ‘จ๐Ÿ’ป Quick startNextEmail customization

Last updated 2 years ago

Was this helpful?

Seeing the result live

When building your page you want to see the result of your edit live.

To acheave that with Keycloakify simply eddit:

 import { getKcContext } from "keycloakify";

 const { kcContext } = getKcContext({
+    "mockPageId": "login.ftl"
 });

.

.

then if you run yarn start you will see your login page display. Dont forget to remove mockPageId before releasing ๐Ÿ˜‰.

The page is loaded with a default mock context.

To customize the mock kcContext please refer to .

Testing in a real Keycloak instance

Once you are done developping you want to test in an actual Keycloak instance to see if everything is working as expected.

Please refer to the related instruction printed on the console when running yarn keycloak in your project.

๐Ÿงช
See the getKcContext() call in the keycloakify-demo-app project
See the getKcContext() call in the keycloakify-demo-app#look_and_feel project
this example
The instruction for starting a test container are displayed when you build the theme.