History

Erik Jan de Wit 43de7d6121 added extra install step to suggested steps (#32149 ) Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>		2024-08-16 08:37:49 +02:00
..
templates	initial version of the kc-create tool (#31314 )	2024-07-29 13:47:32 +02:00
create.js	added extra install step to suggested steps (#32149 )	2024-08-16 08:37:49 +02:00
package.json	added `bin` to package.json to make it executable (#32052 )	2024-08-13 11:29:48 +02:00
README.md	added `bin` to package.json to make it executable (#32052 )	2024-08-13 11:29:48 +02:00

README.md

kc-create

Create a new Keycloak ui project based on a template

Usage

npm create keycloak-theme <name> [options]

Options

-t, --type <name> the type of ui to be created either account or admin (currently only account is supported)

Example

npm create keycloak-theme my-project -t account

This will create a new project called my-project with an account ui based on the template from the quickstarts repo. After the project is created, the following commands can be used to start the server and open the ui in a browser:

cd my-project
npm run dev

And then run keycloak in the background:

npm run start-keycloak

Then open the ui in a browser:

open http://localhost:8080