Skip to main content

Getting Started

This guide provides the necessary steps to set up and run the Citadel Shell Application in a local development environment.

Prerequisites​

Before you begin, ensure you have the following installed:

  • Node.js (LTS version recommended)
  • pnpm (as the package manager for this monorepo)

1. Install Dependencies​

From the root of the citadel monorepo, install all necessary dependencies for the shell application.

pnpm install --filter=shell-app

2. Configure the Application​

The shell application requires a /public/assets/config.json file for its runtime configuration. A script is provided to generate a default configuration for local development.

This script reads environment variables to populate the configuration. For a standard local setup where the iam-service is running, you typically do not need to set any environment variables.

To generate the configuration, run the following command from the apps/shell-app directory:

OIDC_CLIENT_ID=b048264c-9322-4fe8-8c75-cf300f62164c OIDC_PROMPT=login node scripts/generate-config.js

This will create a config.json file in the public/assets/ directory with default values suitable for local development.

3. Start the Development Server​

Once the dependencies are installed and the configuration is generated, you can start the local development server.

OIDC_CLIENT_ID=b048264c-9322-4fe8-8c75-cf300f62164c OIDC_PROMPT=login pnpm --filter=shell-app start

The application will be available at http://localhost:5000.