Installing IBM DOC 4.0.0 from scratch on Windows: a video tutorial

This article goes through all the steps of installing the software required by IBM DOC 4.0.0, then DOC 4.0.0 itself, then executing it to generate an application, then building the application, packaging it as Docker images, and running it from these Docker images. All these steps are explained in the IBM DOC 4.0.0 Documentation, however, the videos in this article may make things clearer.

These videos have been created on a blank Windows 10 system. Depending on your OS and the software you have already installed, you may skip some steps. If you do, make sure that the versions of the software you already have installed meet the minimal requirements.

The installation process includes several reboots, so you may want to watch these videos from a different computer.

Contents

Installing Required Software

The software required by DOC 4.0.0 is listed on the Requirements page of the documentation.

Web Browser

The supported browsers are the latest versions of Mozilla Firefox and Google Chrome. Either can be used for running an application generated with DOC 4.0, but Chrome is needed to run the tests of the front-end components.

Mozilla Firefox

The video below shows the installation of Mozilla Firefox.

Google Chrome

The video below shows the installation of Google Chrome.

Java SDK

The video below shows the installation of the AdoptOpenJDK SDK for Java 8.

NodeJS

The video below shows the installation of NodeJS.

Docker and Docker Compose

The video below shows the installation of Docker Desktop for Windows (Community Edition), which includes both the Docker engine and Docker Compose.

After the installation of Docker, a couple of settings are needed.

Unix shell emulator

The video below shows the installation of Git, which comes with Git Bash, a Unix shell emulator. Git Bash and Cygwin are similar.

Installing DOC 4.0.0

The installation of DOC 4.0.0 is discussed on the Installation page of the documentation. The DOC 4.0.0 software consists of:

• An application scaffolding program. This program is a “generator” of the generic Yeoman application generation software. Both Yeoman and the DOC generator are delivered as an NPM (NodeJS Package Manager) packages.
• A collection of JVM-based libraries, packaged as Maven components, and of Javascript-based libraries, packaged as NPM packages.

These Maven components and NPM packages are served by a dedicated Nexus repository. Access to this repository requires authentication. This is discussed in the following video, but credentials are redacted. You should have received them independently.