Applipress config.json file

The config.json file is a crucial component of the Applipress application, acting as the central configuration file. Located within the ./config/applipress/ directory, this JSON file enables users to customize the application's behavior and manage project tracking efficiently. Here’s a closer look at its structure and functionalities:

Initial Structure

Upon initial setup, the config.json file presents the following default configuration:

                  { "globalFolder": "/templates/",
                  "currentProjectId": null, "debug": false,
                  "defaultProjectsDir": "/projects/",
                  "projects": [] }
                

Configuration Parameters

globalFolder: Specifies the directory path where the templates used for source generation are stored. This allows for the integration of custom templates tailored to your development needs.
currentProjectId: Indicates the ID of the currently active project. This field is dynamically updated by Applipress.
debug: A boolean flag that, when set to true, enables the debug mode. This provides visibility into the JHipster log inside the Applipress Docker container, aiding in troubleshooting and development.
defaultProjectsDir: Defines the default directory path where projects are stored, serving as the primary location for project files.
projects: An array that holds objects representing the projects created within Applipress. Each object includes the project’s id, name, projectFolder, and modelFolder.

User-Changeable Properties

While config.json contains several settings, users are encouraged to modify only the globalFolder, debug, and defaultProjectsDir properties. The projects array is automatically managed by Applipress and should generally not be edited manually to ensure the integrity and proper tracking of projects.

Example with Multiple Projects

In an Applipress environment with several projects, the config.json file may resemble the following structure, showcasing the variety of projects managed by the application:

                  { "globalFolder": "/templates/",
                  "defaultProjectsDir": "/projects/",
                  "currentProjectId": 5, "debug": false,
                  "projects": [ { "id": 1, "name":
                  "billing1", "projectFolder":
                  "/projects/billing1", "modelFolder":
                  "/projects/billing1/model" }, { "id": 2,
                  "name": "billing2",
                  "projectFolder": "/projects/billing2",
                  "modelFolder": "/projects/billing2/model"
                  }, { "id": 3, "name":
                  "billing3", "projectFolder":
                  "/projects/billing3", "modelFolder":
                  "/projects/billing3/model" }, { "id": 4,
                  "name": "invoice",
                  "projectFolder": "/projects/invoice",
                  "modelFolder": "/projects/invoice/model"
                  }, { "id": 5, "name":
                  "service_catalogue", "projectFolder":
                  "/projects/service-catalog",
                  "modelFolder":
                  "/projects/service-catalog/model" } ] }
                

Last modified: 18 March 2024