💟Contributing
Looking for submitting a PR? Thank you!
Adding support for a new page
Here is an example of a good PR that adds support for a page.
If you need to edit the i18n resources it should be done here (and not in the src/lib/i18n/generated_kcMessages
dir).
You can download the FTL/CSS source files the components are based on with the following command:
npx -p keycloakify download-builtin-keycloak-theme
Testing your changes in the demo app (or in your project)
Let's assume you have made some change to the keycloakify
codebase and you want to test those changes before submitting a PR.
Assuming you have cloned keycloakify in ~/github/keycloakify
this is how you would proceed.
Open a new terminal window
Now you are able to test your local version of Keycloakify in the test app and make sure everything works as expected.
If you want to link your local version of keycloakify
in your own app instead of the keycloakify-starter
just run yarn link_in_test_app <your_app>
(Assuming ../<your_app>
exsist)
Heads over the development instruction if you are not already familiar with the process of testing your Keycloakify themes: