Initializing the project structure
The Micro RadiantMicro Radiant (MicroRadiant). The graphical modeling IDE and tooling environment used to design, edit, and maintain NS applications and project models. is the visual model editor developed by NSX. It serves as the primary interface for developers and analysts to define, view, and update the applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. model, which is the software equivalent of the real-world business requirements.
Initializing our application
The ApplicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. Project screen provides a streamlined way to set up a new applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. according to the defined Normalized SystemsSystemA set of interconnected components that work together to achieve a specific purpose or function. (NS) structure.
Step 1: Prepare your directory
First, create the project directory that will serve as the home for your new applicationsApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution., workspace. This step is
performed in your file systemSystemA set of interconnected components that work together to achieve a specific purpose or function., not the applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. screen.
Example Directory Structure:
/my/development/path/workspace/
Step 2: Launch the application
Start the Micro RadiantMicro Radiant (MicroRadiant). The graphical modeling IDE and tooling environment used to design, edit, and maintain NS applications and project models. applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. by clicking its icon. You will be immediately prompted with a screen to open or import a project.
Step 3: Installing our first plugin
By default, the Micro RadiantMicro Radiant (MicroRadiant). The graphical modeling IDE and tooling environment used to design, edit, and maintain NS applications and project models. editor a limited set of functionality. To extend it, we can install Plugins.
To create our first applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution., we will install the mrp-nsinit-plugin (nsinit is short for NS Initializer).
- Navigate to the top menu
- Select Settings
- Select Plugins
- Search for "nsinit"
- Select and install net-democritus-nsinit-plugin
- Restart
Step 4: Initialize a new project
Open the Micro RadiantMicro Radiant (MicroRadiant). The graphical modeling IDE and tooling environment used to design, edit, and maintain NS applications and project models. and select initialize Project. In the new screen we will choose the location of our NS applicationNS Application (NSApplication). A pre-built software stack that provides common enterprise application functionality such as CRUD, search, authentication, and business process modeling out of the box..
- Select location and navigate to the
workspacefolder you previously created - fill in
euRentas folder name - Click Initialize Project
Step 5: Configuring our initialization step
The ApplicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. Project setup screen should be shown after initializing, we will now configure the default settings of our applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution..
The center panel of the screen allows you to input the core metadata for your applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution.. We will use the following values, corresponding to the fieldsFieldA property of a DataElement expanded to a database column and user interface input element. in the attached image:
| Input FieldFieldA property of a DataElement expanded to a database column and user interface input element. | Value | Description |
|---|---|---|
| applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. | euRent | The applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution.’s unique identifier. |
| applicationInstance | euRent | The name for this specific instance. |
| component | rentWork | Our main component for rental management. |
| groupld | org.normalizedsystems | Standard Maven naming convention for the project. |
| dockerImage | nsapp/euRent | The default Docker image name is automatically suggested based on the applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. name. Leave as default. |
Step 6: Select optional features
The right panel lists various optional features and integrations for the project. Check or uncheck the boxes based on the required setup. The tutorial requires the following selections:
| Feature | Check/Uncheck Status |
|---|---|
| jenkins | Unchecked (We will ignore external build pipeline settings for now.) |
| git | Unchecked (You can set this up manually later if required.) |
| gitFlow | Unchecked |
| sonar | Unchecked |
| modelValidation | Unchecked |
| baseComponents | Checked (Includes essential cross-cutting modules like account, assets, etc.) |
| Docker | Checked (To generate files to package the applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. as a Docker image.) |
| releasePromotion | Unchecked |
| scripts | Checked (To generate utility/demo scripts.) |
| aws | Unchecked |
| examples | Unchecked |
Step 7: Save the project
After filling in all the required fieldsFieldA property of a DataElement expanded to a database column and user interface input element. and selecting the desired options, click the main action button in the center of the screen:
- Click: Initialize Project
The systemSystemA set of interconnected components that work together to achieve a specific purpose or function. will now generate the complete directory structure, XML model definition files, configuration settings, and
utility scripts in the euRent folder you prepared in Step 1.
You have successfully completed the first major step and established the foundational structure of your Normalized SystemSystemA set of interconnected components that work together to achieve a specific purpose or function. applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. using the GUI.