Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.26 KB

README.md

File metadata and controls

44 lines (30 loc) · 1.26 KB

keycloak-theme-template

This is a cookiecutter template for Keycloak custom themes.

Purpose

This template is used to scaffold a custom theme for Keycloak.

Installation

Firstly, you will need to install cookiecutter:

pip install cookiecutter

Usage

Create a new project with

cookiecutter gh:Blueshoe/keycloak-theme-template

and answer the questions accordingly.

What's in

This template creates the entire project layout required for a theme repository. We're usually building our themes directly into a custom Keycloak container image. The development setup comprises the following components

  • a docker-compose setup for local development:
    • Keycloak image from the requested tag
    • PostgreSQL database
    • a Mock SMTP server to send mails to and get instant feedback about the styles and layout
  • start development with the official keycloak theme as a basis
  • a comprehensible documentation how to do things
  • a Dockerfile to build and provide the customized image

Credits

This cookiecutter template is heavily inspired by keycloak-theme-govuk. Please check out their awesome work.