Clone the repo into the theme directory of your keycloak install. Log into the Administration Console, choose the desired realm, then goto Realm settings -> Themes and select the theme.
It is highly recommended to read the documentation on creating Keycloak themes before getting started. Here's a brief summary:
- Each top level directory corresponds to a theme type:
account,admin,commmon,emailorlogin. - The file
theme.propertiesin each theme type contains a long list of properties. Most noteably it specifies the parent theme. - HTML templates are coded using FreeMarker Template Language (
.ftl). - The
resourcedirectory for a theme contains stylesheets, scripts, imgaes, and so on.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.