Prerequisites

Node.js & npm

Make sure you have Node.js installed. Download the installer here or use your favorite package manager. You must download the installer according to your platform and operating system. It’s suggested to use the *12.x.x** version of node along with the 6.x.x version of npm. We’ve found this combination to be the fastest and most stable for Ontimize Web.

Following installation, make sure you have correctly installed Node.js by invoking the following commands in the command-line:

NOTE: On the Mac, the command-line is available via the Terminal application. On the PC, it’s available as Command Prompt under Accessories.

# Checking node version
C:\>node -v
v12.10.0
# Checking npm version
C:\>npm -v
6.10.3

If you want to know more about npm you can find more information here.

Angular CLI

You need to have installed Angular CLI to build applications and to generate components and modules.

# Installing angular CLI package globally
npm install -g @angular/cli@latest

Note: ‘ontimize-web-ngx@8.0.0’ is using ‘@angular/cli@8.3.25’

Python

You need to have Python installed (v2.7 recommended, v3.x.x is not supported). Download the installer here according your operating system.

Git

Git is also necessary to be able to download resources from Imatia’s code repositories. Download the installer here according your operating system.

Visual Studio Code

It is not absolutely necessary to use this IDE, if highly recommended, but certain .dll inherent in installation for some of the tools Ontimize compilation of web applications are needed. Download the installer here according your operating system.

While the use of this IDE is not required (although it is recommended), the dynamic libraries installed with the IDE are used by some of the Ontimize compilation tools. Download the installer here according your operating system.

Troubleshooting

Here are some solutions to common problems related with Node.js installations on different operating systems.

Node.js addons

Install dependencies needed by the Node.js native addon build tool (node-gyp):

More information here. You can install with npm:

$ npm install -g node-gyp

You will also need to install:

  • On Unix:
    • python (v2.7 recommended, v3.x.x is not supported)
    • make
    • A proper C/C++ compiler toolchain, like GCC
  • On Mac OS X:
    • python (v2.7 recommended, v3.x.x is not supported) (already installed on Mac OS X)
    • Xcode
      • You also need to install the Command Line Tools via Xcode. You can find this under the menu Xcode -> Preferences -> Downloads
      • This step will install gcc and the related toolchain containing make
  • On Windows:
    • Option 1: Install all the required tools and configurations using Microsoft’s windows-build-tools using npm install --global --production windows-build-tools from an elevated PowerShell or CMD.exe (run as Administrator).
    • Option 2: Install tools and configuration manually:
      • Visual C++ Build Environment:
        • Option 1: Install Visual C++ Build Tools using the Default Install option.

        • Option 2: Install Visual Studio 2015 (or modify an existing installation) and select Common Tools for Visual C++ during setup. This also works with the free Community and Express for Desktop editions.

        :bulb: [Windows Vista / 7 only] requires .NET Framework 4.5.1

      • Install Python 2.7 (v3.x.x is not supported), and run npm config set python python2.7 (or see below for further instructions on specifying the proper Python version and path.)
      • Launch cmd, npm config set msvs_version 2015

    If the above steps didn’t work for you, please visit Microsoft’s Node.js Guidelines for Windows for additional tips.

If you have multiple Python versions installed, you can specify which Python version node-gyp uses by setting the ‘–python’ variable:

$ node-gyp --python /path/to/python2.7

If node-gyp is called by way of npm and you have multiple versions of Python installed, then you can set npm’s ‘python’ config key to the appropriate value:

$ npm config set python /path/to/executable/python2.7