Blueprint Developer Manual / 3.1.1 Developer Setup

Blueprint Developer Manual / Version 2310

3.1.1 Developer Setup

These are the prerequisites for your local machine where you develop CAE templates or CoreMedia Studio extensions, for example.

Hardware

At least a dual-core CPU with 2GHz, a quad-core CPU is recommended, because CoreMedia CMS code makes heavy use of multithreading.
The minimum RAM you need is 8 GB which is enough if your locally tested components are connected to remote Test System Setup.

Required Software

A supported Java SDK (see http://bit.ly/cmcc-11-supported-environments). The variable JAVA_HOME must be set.
A supported browser (see http://bit.ly/cmcc-11-supported-environments)
A supported Maven installation, (see http://bit.ly/cmcc-11-supported-environments).
A supported Node installation, (see http://bit.ly/cmcc-11-supported-environments)
A supported pnpm installation, (see http://bit.ly/cmcc-11-supported-environments)
An IDE. CoreMedia suggests IntelliJ Idea because it has the best support for CoreMedia Studio development.
A supported container environment, see Section 3.2.2, “Docker Compose Setup” and http://bit.ly/cmcc-11-supported-environments for details.
A supported Sencha Cmd release (see http://bit.ly/cmcc-11-supported-environments).
If you want to build the workspace with tests, you need an up-to-date version of Google Chrome installed on your computer. It must be contained in your path.
CoreMedia license files for starting the various Content Servers. If you do not already have the files, request your licenses from the CoreMedia support.

OEM Licenses

CoreMedia has an OEM license agreement in place for the following software components:

These licenses are part of any CoreMedia license agreement, and allow use, and extension of, these components in the context of CoreMedia products. Therefore, you are free to extend CoreMedia Studio using ExtJS and the required tools by Sencha and to use and extend CKEditor in your CoreMedia projects.

Installing Sencha Cmd

You can install Sencha Cmd globally by using npm. To install Sencha Cmd, run the following command:

npm install -g @sencha/cmd

Make sure, that Sencha Cmd is available in your PATH variable.

You might have issues while installing or using Sencha Cmd depending on your operating system.

Windows

As a Windows user you might experience the following error message when trying to install Sencha Cmd as mentioned above.

Packages: +3
+++
Progress: resolved 4, reused 4, downloaded 0, added 0, done
.pnpm/@sencha+cmd@7.8.0/node_modules/@sencha/cmd: Running install script, failed in 181ms
.../node_modules/@sencha/cmd install$ node platform-install.js
│ i [ext]: platform-install: @sencha/cmd v7.8.0 installed
│ node:internal/child_process:414
│     throw errnoException(err, 'spawn');
│     ^
│ Error: spawn EINVAL
│     at ChildProcess.spawn (node:internal/child_process:414:11)
│     at Object.spawn (node:child_process:761:9)
│     at proceedWithInstall (C:\Users\yourname\AppData\Local\pnpm\global\5\.pnpm\@sencha+cmd@7.8.0\node_modules\@sencha\cmd\p…
│     at C:\Users\yourname\AppData\Local\pnpm\global\5\.pnpm\@sencha+cmd@7.8.0\node_modules\@sencha\cmd\platform-install.js:1…
│     at C:\Users\yourname\AppData\Local\pnpm\global\5\.pnpm\which@1.3.1\node_modules\which\which.js:87:20
│     at C:\Users\yourname\AppData\Local\pnpm\global\5\.pnpm\isexe@2.0.0\node_modules\isexe\index.js:42:5
│     at C:\Users\yourname\AppData\Local\pnpm\global\5\.pnpm\isexe@2.0.0\node_modules\isexe\windows.js:36:5
│     at FSReqCallback.oncomplete (node:fs:203:5) {
│   errno: -4071,
│   code: 'EINVAL',
│   syscall: 'spawn'
│ }
│ Node.js v18.20.4
└─ Failed in 182ms at C:\Users\yourname\AppData\Local\pnpm\global\5\.pnpm\@sencha+cmd@7.8.0\node_modules\@sencha\cmd
 ELIFECYCLE  Command failed with exit code 1.

The reason for this error is a security patch in the latest Node.js versions, that is not yet fixed in the Sencha Cmd package at the time of writing, but will probably be fixed soon (see Node.js — Wednesday, April 10, 2024 Security Releases (nodejs.org) . If you experience this problem, install Sencha Cmd as follows:

Install with the --ignore-scripts parameter:

npm install --ignore-scripts -g @sencha/cmd@7.7.0

Find the installation folder of Sencha Cmd like this:

npm list -g -p | find "sencha"
C:\Users\yourname\nvm\v18.20.4\node_modules\@sencha\cmd

Navigate to this folder and open the file platform-install.js. Look for the following line:

let options = {cwd: path.join(__dirname), stdio: 'inherit', encoding: 'utf-8'}

Add the option shell:true:

let options = {cwd: path.join(__dirname), stdio: 'inherit', encoding: 'utf-8', shell: true}

Run the script platform-install.js manually:

node <path-to-sencha-installation>/platform-install.js

Test your installation with the following command:

> sencha which
Wat!
configFile: <path-to-sencha-installation>\dist\sencha.cfg
Sencha Cmd v7.8.0.59
<path-to-sencha-installation>/dist/

Do not forget to adapt the path to your system installation.

 set PATH = <path-to-sencha-installation>/dist/;%PATH%

WSL on Windows

You might get an error message like the following:

ERROR: spawn /home/yourname/.nvm/version/node/v18.15.0/lib/node_modules/@sencha/cmd/dist/sencha EACCES
at ChildProcess._handle.onexit (node:internal/child_process:283:19)
at onErrorNT (node:internal/child_process:476:16)

In this case you have to make the Sencha Cmd executable. Use the following command and adapt the path to your system installation:

chmod u+x /home/<yourName>/.nvm/versions/node/v18.19.0/lib/node_modules/@sencha/cmd/dist/sencha

MacOs

Some Mac users reported the following error when building the studio-client workspace:

ERROR: Execution of Sencha Cmd failed

If you encounter this error you should delete the file /Users/<user>/Library/Application Support/Sencha/Cmd/update/app.properties. Keep in mind that the Library folder might be hidden in your Finder window.

Search Results

Table Of Contents

Filter