keycloak-scim/js/apps/create-keycloak-theme/README.md
Erik Jan de Wit afec4401fc
initial version of the kc-create tool (#31314)
* initial version of the kc-create tool

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

* Update js/apps/kc-create/package.json

Co-authored-by: Jon Koops <jonkoops@gmail.com>
Signed-off-by: Erik Jan de Wit <edewit@redhat.com>

* renamed and addressed review

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

---------

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>
Signed-off-by: Erik Jan de Wit <edewit@redhat.com>
Co-authored-by: Jon Koops <jonkoops@gmail.com>
2024-07-29 13:47:32 +02:00

38 lines
No EOL
757 B
Markdown

=== kc-create
Create a new Keycloak ui project based on a template
## Usage
```bash
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
```bash
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:
```bash
cd my-project
npm run dev
```
And then run keycloak in the background:
```bash
npm run start-keycloak
```
Then open the ui in a browser:
```bash
open http://localhost:8080
```