Skip to main content

Getting Started with Project Setup

The easiest way to get started is to use the NS initializer and create a new applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution.. This will expand all the necessary files for the project setup and the 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.. For existing projects there is also a migration guide. It is highly recommended to first read the the documentation about the project setup before migrating.

Default setup​

The NS initializer creates the default directory structure of a project setup. See Directory structure for what each directory and file contains.

Viewing and configuring the model​

It is recommended to update the model using the micro radiantMicro Radiant (MicroRadiant). The graphical modeling IDE and tooling environment used to design, edit, and maintain NS applications and project models..

Use micro radiantMicro Radiant (MicroRadiant). The graphical modeling IDE and tooling environment used to design, edit, and maintain NS applications and project models. 4.5 or later (see Directory structure).

  1. Install the org-normalizedsystems-northstar-project-plugin plugin if you haven't already.
  2. Import a new project in the micro radiantMicro Radiant (MicroRadiant). The graphical modeling IDE and tooling environment used to design, edit, and maintain NS applications and project models.
  3. Select the root directory of your project. You should see two expansionSettings files found (.nsproject and conf/expansionSettings).
  4. Give the project a fitting name.
  5. Switch between expansionSettings files using the project facet in the left column.
  6. You can now start editing the model.

More info about importing projects in micro radiantMicro Radiant (MicroRadiant). The graphical modeling IDE and tooling environment used to design, edit, and maintain NS applications and project models. can be found here.