Initialize a Project

This tutorial walks you through initializing a new CM MES project using the cmf init command.

1. Create the project folder

Create a folder to store your new customization project files.

Warning

On Windows, some applications and libraries do not support file paths longer than 256 characters. CM MES customization projects have long file paths. To avoid problems on Windows OS, you should:

• Use short project file names;
• Initialize your projects on a folder as nearest as possible to the filesystem drive root.

2. Open PowerShell command line

Open a PowerShell terminal and navigate to your new project folder.

3. Check Node.js and NPM Version

Run the following commands to check your current versions:

# Check Node.js version
node -v

#Check NPM version
npm -v

Validate that their versions match the compatibility list stated in the installation guide. If needed, use nvm command to fix it.

4. Initialize Project

You can initialize a MES Customization or App project workspace using the cmf init command. The following examples illustrate its usage.

Software and MES ISO Dependencies

• Dependencies Version: To determine the software dependencies version to use on the init command, check the instructions on the Project Types Concept page.
• MES ISO location is optional: You only need to provide this parameter if your MES or one of its optional components runs on a Windows environment. More details on MES components are available on the MES System Architecture page.

MES v10 or aboveMES v9 or belowMES App

cmf init ExampleProject `
    --version 1.0.0 `
    --infra ..\config\infra.json `
    --config ..\config\env.json `
    --MESVersion 11.0.0 `
    --nugetVersion 11.0.0 `
    --testScenariosNugetVersion 11.0.0 `
    --deploymentDir \\directory\Deployments `
    --ISOLocation \\directory\CriticalManufacturing.iso `
    --ngxSchematicsVersion 11.0.0

cmf init ExampleProject `
    --version 1.0.0 `
    --infra ..\config\infra.json `
    --config ..\config\ExampleEnvironment.json `
    --MESVersion 9.0.11 `
    --nugetVersion 9.0.11 `
    --testScenariosNugetVersion 9.0.11 `
    --deploymentDir \\vm-project\Deployments `
    --ISOLocation \\setups\CriticalManufacturing.iso `
    --DevTasksVersion 8.1.3 `
    --HTMLStarterVersion 8.1.1 `
    --yoGeneratorVersion 3.1.0

cmf init ExampleProject `
    --version 1.0.0 `
    --infra ..\config\infra.json `
    --config ..\config\ExampleEnvironment.json `
    --MESVersion 11.0.0 `
    --nugetVersion 11.0.0 `
    --testScenariosNugetVersion 11.0.0 `
    --deploymentDir \\directory\Deployments `
    --ngxSchematicsVersion 11.0.0 `
    --appName "My App" `
    --appId "MyApp" `
    --appAuthor "Critical Manufacturing" `
    --appDescription "My First App" `
    --appTargetFramework 11.0.0 `
    --appLicensedApplication "My App" `
    --repositoryType "App"

5. Review the created project structure

The cmf init command should have terminated with success and created a basic project structure similar to:

📦ExampleProject
┣ 📂.config               # Dotnet tools configuration
┃ ┗ 📜dotnet-tools.json
┣ 📂EnvironmentConfigs    # Environments configuration repository
┃ ┗ 📜ExampleEnvironment.json
┣ 📂Libs                  # External libs dependencies (binaries)
┃ ┗ 📂...
┣ 📜.gitignore            # Spec files to ignore
┣ 📜.project-config.json  # Project configuration used during scaffolding
┣ 📜cmfpackage.json       # Project root package
┣ 📜global.json           # Dotnet global.json
┣ 📜NuGet.Config          # NuGet repository configuration
┗ 📜repositories.json     # The build/release repositories configuration

Note

The initial project structure may vary, depending on the CM CLI version and the project type selected (--repositoryType argument).

6. Validate repositories.json

Verify the repositories.json file in the project root folder conforms to the specification.

7. Add LBOs SDK

Store your environment's LBOs in the Libs\LBOs directory of your project.

8. Store project on source control

Use a source control system (like Git) to manage your project versions.

Store the result of cmf init in the source control.

Note

The CM CLI assumes that you are using git. If that is not the case, adapt .gitignore files to your source control system.