Developer prerequisites

Before you can attend the developer onboarding for Naviga Web you need to verify these on your local developer machine. And know how to use them.

TL;DR: 4 requirements to fix and learn before we start.

• Computer

• Bash

• Git

• Docker

Computer hardware and OS

Requirement: Intel Mac or PC (Windows with a CPU that supports virtualisation, or Linux)

Why: Naviga Web has been verified to work with Mac and PC with Intel CPU. Intel Mac is preferred but not required. We have a list with hardware examples, proven to work fine with Naviga Web development.

Running on Windows requires some extra preparations.

Mac: Verify that your Mac has Intel processor with:  > About this Mac > Processor

PC with Windows: Verify that your Windows version and build match the requirements for running WSL 2 with: Control Panel > System

Bash

Requirement: Bash is included with Mac, and with WSL on Windows.

Why: The make commands are needed to control the local Docker containers. Needed to do things like start, stop, init, update locally.

Verify that you have bash by running:

% bash --version 
GNU bash, version 3.2.57(1)-release (x86_64-apple-darwin21)
Copyright (C) 2007 Free Software Foundation, Inc.

Git

Requirement: Git client

Why: Git is used to access and version your code. Working with git.

Verify that you have git by running this in your code project folder:

% cd YOUR_PROJECT
% git status
On branch develop
Your branch is up to date with 'origin/develop'.

nothing to commit, working tree clean

Docker

Requirement: Make sure you have Docker installed and working with Naviga Web containers.

Why: All that is needed to host a development instance of Naviga Web runs within Docker. This includes internal cache, database, proxy, PHP and web servers.

Verify that you have Docker by running:

% docker info
Client:
 Context:    default
 Debug Mode: false
 Plugins:
  buildx: Build with BuildKit (Docker Inc., v0.6.3)
  compose: Docker Compose (Docker Inc., v2.0.0)
  scan: Docker Scan (Docker Inc., v0.8.0)

Server:
 Containers: 0
  Running: 0
  Paused: 0
  Stopped: 0
...

Node 10 (not required)

Starter kit asset (CSS/JavaScript) compilation use Gulp v3 requiring Node 10.23.1. If you need to compile assets locally, install Node.js version 10 with NVM.

Workaround: Without Node you can still use the bundled node version, within Docker container. It will take much longer to run.

Verify your Node version by running:

% node -v
v10.23.1