### Developer Quick Start: Cloning and Setup Source: https://github.com/almig-kompressoren-gmbh/tailcloakify/blob/main/README.md Commands to clone the Tailcloakify repository and install its dependencies using Yarn. Ensure to remove `yarn.lock` if using a different package manager. ```bash git clone https://github.com/ALMiG-Kompressoren-GmbH/tailcloakify cd tailcloakify yarn install ``` -------------------------------- ### Maven Installation Instructions Source: https://github.com/almig-kompressoren-gmbh/tailcloakify/blob/main/README.md Platform-specific commands for installing Maven, a build automation tool required for building the Keycloak theme. Also includes instructions for installing Java on Windows. ```bash # On macOS: brew install maven # On Debian/Ubuntu: sudo apt-get install maven # On Windows: choco install openjdk choco install maven # Or download from https://maven.apache.org/download.cgi ``` -------------------------------- ### Running Keycloak Locally for Theme Testing Source: https://github.com/almig-kompressoren-gmbh/tailcloakify/blob/main/README.md Command to start a local Keycloak instance with the theme applied for testing purposes. ```bash npx keycloakify start-keycloak ``` -------------------------------- ### Building the Keycloak Theme Source: https://github.com/almig-kompressoren-gmbh/tailcloakify/blob/main/README.md Command to build the Keycloak theme JAR files. Requires Maven and Java to be installed and configured in the system's PATH. ```bash npm run build-keycloak-theme ``` -------------------------------- ### Previewing Theme with Storybook Source: https://github.com/almig-kompressoren-gmbh/tailcloakify/blob/main/README.md Command to launch Storybook, which allows for previewing and developing UI components of the theme in isolation. ```bash npm run storybook ``` -------------------------------- ### Testing the Theme Locally Source: https://github.com/almig-kompressoren-gmbh/tailcloakify/blob/main/README.md Command to run the development server for testing the Keycloak theme locally. ```bash npm run dev ``` -------------------------------- ### Tailcloakify Environment Variables Source: https://github.com/almig-kompressoren-gmbh/tailcloakify/blob/main/README.md Customization options for the Tailcloakify Keycloak theme using environment variables. These variables allow for dynamic configuration of logos, scripts, styles, and other visual elements without rebuilding the theme. ```APIDOC TAILCLOAKIFY_ADDITIONAL_SCRIPTS: Use it to add other external scripts TAILCLOAKIFY_ADDITIONAL_STYLES: Use it to add other external styles TAILCLOAKIFY_ADDITIONAL_META: Use it to add other meta tags TAILCLOAKIFY_HIDE_LOGIN_FORM: Use it to hide the default login form for using IDPs only TAILCLOAKIFY_BACKGROUND_LOGO_URL: Use it to add an image of your logo TAILCLOAKIFY_HEADER_LOGO_URL: Use it to add an image of your logo to the header TAILCLOAKIFY_BACKGROUND_VIDEO_URL: Use it to add a MP4 format background video on your register and login pages TAILCLOAKIFY_FAVICON_URL: Use it to add a url to your Favicon TAILCLOAKIFY_FOOTER_IMPRINT_URL: Use it to add an Impressum TAILCLOAKIFY_FOOTER_DATAPROTECTION_URL: Use it to add url to your data protection document TAILCLOAKIFY_FOOTER_ORESTBIDACOOKIECONSENT: Use it to integrate Orestbida cookie consent plugin TAILCLOAKIFY_FOOTER_ORESTBIDACOOKIECONSENT_GOOGLE_CAPTCHA: Provide any falsy value to disable the cookie section for the google captcha TAILCLOAKIFY_SHOW_SOCIAL_PROVIDERS_ON_REGISTER: Use it to show social identity providers on the registration page (set to "TRUE") ``` -------------------------------- ### Keycloak Theme Properties for Child Themes Source: https://github.com/almig-kompressoren-gmbh/tailcloakify/blob/main/README.md Specifies the parent theme and additional scripts or styles to be loaded when creating a child theme in Keycloak. This allows for extending the base Tailcloakify theme. ```properties parent=tailcloakify scripts=first-script.js second-script.js styles=custom-styles.css meta=name==content name2=content2 ``` -------------------------------- ### Keycloak Localization Properties Source: https://github.com/almig-kompressoren-gmbh/tailcloakify/blob/main/README.md Defines localized configuration options for Keycloak themes, allowing customization of elements like logos and URLs based on language. These properties override environment variables. ```APIDOC backgroundLogoUrl: The localized enabled alternative to env: TAILCLOAKIFY_BACKGROUND_LOGO_URL headerLogoUrl: The localized enabled alternative to env: TAILCLOAKIFY_HEADER_LOGO_URL backgroundVideoUrl: The localized enabled alternative to env: TAILCLOAKIFY_BACKGROUND_VIDEO_URL faviconUrl: The localized enabled alternative to env: TAILCLOAKIFY_FAVICON_URL footerImprintUrl: The localized enabled alternative to env: TAILCLOAKIFY_FOOTER_IMPRINT_URL footerDataprotectionUrl: The localized enabled alternative to env: TAILCLOAKIFY_FOOTER_DATAPROTECTION_URL showSocialProvidersOnRegister: The localized enabled alternative to env: TAILCLOAKIFY_SHOW_SOCIAL_PROVIDERS_ON_REGISTER ``` -------------------------------- ### Conventional Commits Standard Source: https://github.com/almig-kompressoren-gmbh/tailcloakify/blob/main/CONTRIBUTING.md Defines the structure for commit messages, including type, scope, description, body, and footers. This standard helps in automating changelog generation and understanding commit history. ```bash [optional scope]: [optional body] [optional footer(s)] ``` -------------------------------- ### Commit Types for Tailcloakify Source: https://github.com/almig-kompressoren-gmbh/tailcloakify/blob/main/CONTRIBUTING.md Lists the different types of commits recognized by the project, each indicating the nature of the change made to the Tailcloakify package. This helps categorize changes for better tracking and understanding. ```bash - feat: Adding a new snippet or significant functionality to the Tailcloakify package. - fix: Addressing bugs or issues in existing Tailcloakify package. - docs: Commits related to documentation changes for Tailcloakify package. - style: Commits related to code formatting, styling, or theming of Tailcloakify package. - refactor: Code changes that enhance the library's structure without introducing new features or fixing bugs. - perf: Commits aimed at improving performance for Tailcloakify package. - test: Commits related to testing Tailcloakify package. - chore: Other commits not affecting source or test files directly. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.