Curity UI Kit

Customize the look and feel of your applications

This monorepo contains:

• Identity Server Templates
• Self Service Portal
• CSS Library
• UI Icons React Library
• React Component Library

Prerequisites

• Node.js (version as specified in the .nvmrc file)

Setup

This project uses a specific Node.js version as specified in the .nvmrc file. We recommend using nvm (Node Version Manager) to ensure compatibility.

Using nvm

If you have nvm installed, you can automatically use the correct Node.js version by running:

nvm use

This will read the version from .nvmrc and switch to it. If the specified version isn't installed, you'll be prompted to install it with:

nvm install

Installing nvm

If you don't have nvm installed:

• macOS/Linux: Follow the official installation guide
• Windows: Use nvm-windows

Install

To install all dependencies across a monorepo using npm workspaces, you just run:

npm install

Start Preview Servers

To start preview servers concurrently for all projects, run:

npm start

Then you can access the projects at:

• Curity Identity Server Templates: http://localhost:3000
• Self Service Portal: http://localhost:5173/previewer
• Curity CSS Docs: http://localhost:4321/

To start projects individually, run:

• npm start:identity-server - to start the Curity Identity Server Templates
• npm start:ssp to start the Self Service Portal

Build

To build everything, run:

npm run build

To build projects individually, run:

• npm run build:identity-server to build the Identity Server Templates
• npm run build:ssp to build the Self Service Portal
• npm run build:css to build Curity CSS library
• npm run build:icons to build Curity UI Icons React library

Deploy

To deploy build artifacts (assets, templates, and messages) to a production environment, you can use the deploy.sh script.

Prerequisites

1. Set the IDSVR_HOME environment variable to your Identity Server installation directory:

   export IDSVR_HOME=/path/to/idsvr/dist

2. Build the projects before deploying:

   npm run build

Deployment Options

Deploy to overrides (default):

./deploy.sh

This deploys:

• Identity Server assets, templates, and messages
• Self Service Portal to templates/overrides and messages/overrides

Deploy to a specific template area:

./deploy.sh my-template-area

This deploys:

• Identity Server assets, templates, and messages
• Self Service Portal only to the specified template area (not to overrides)

What Gets Deployed

Identity Server:

• Assets (CSS, Fonts, Images, JS) → ${IDSVR_HOME}/usr/share/webroot
• Templates → ${IDSVR_HOME}/usr/share/templates
• Messages → ${IDSVR_HOME}/usr/share/messages

Self Service Portal:

• Templates → ${IDSVR_HOME}/usr/share/templates/overrides/apps/self-service-portal or template-areas/{area}/apps/self-service-portal
• Messages → ${IDSVR_HOME}/usr/share/messages/overrides/{language}/apps/self-service-portal or template-areas/{area}/{language}/apps/self-service-portal

License

Licensed under the Apache License, Version 2.0. See LICENSE.