keycloak-scim/js/apps/create-keycloak-theme/README.md
Erik Jan de Wit 61726e12c4
added bin to package.json to make it executable (#32052)
Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>
2024-08-13 11:29:48 +02:00

38 lines
No EOL
755 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
```