src/app/core/setup/base-config.ts
Describes a base configuration that can be used with the SetupService to initialize a system with predefined settings.
Properties |
|
| description |
description:
|
Type : string
|
|
Description of the scenario of this base configuration (can contain Markdown formatting). |
| id |
id:
|
Type : string
|
|
ID of the base configuration. |
| locale |
locale:
|
Type : string
|
| Optional |
|
The locale (language) of this configuration. |
| name |
name:
|
Type : string
|
|
Human-readable name |
export interface BaseConfig {
/**
* ID of the base configuration.
*/
id: string;
/**
* Human-readable name
*/
name: string;
/**
* Description of the scenario of this base configuration
* (can contain Markdown formatting).
*/
description: string;
/**
* Names of json files that should be imported during the setup process.
* Files have to be located in the `assets/base-configs/${id}/` folder
* and match
*/
entitiesToImport: string[];
/**
* The locale (language) of this configuration.
*/
locale?: string;
}