Naviga Web
Docs Home
  • Introduction
  • Release notes
  • Starter kit
    • Introduction
    • Environment Variables
    • Makefile
    • Changelog
    • API
  • Feature: Advanced Search
    • User guide
    • Search Help
    • How to Setup
    • Technical Details
  • Developer documentation
    • Developer prerequisites
      • Developer hardware suggestions
      • Setup on Windows
      • Setup on Linux/Ubuntu
    • Getting started with development
      • Composer package management
      • Gulp and asset building (optional)
      • Git
      • Hosts file
      • Certificate
      • Initiate Naviga Web
      • Start Naviga Web
      • Bin scripts
      • Create theme
      • Environments
      • Deployment
      • Onboarding tasks
        • #0 - New site
        • #1 - Configuration
        • #2 - Front page
        • #3 - Content presentation
        • #4 - OC List
        • #5 - Content containers
        • #6 - Teaser template
        • #7 - Single article
        • #8 - Widget
        • #9 - Custom task
        • #10 - Feedback
    • Architecture
    • Paywall and authentication
      • CloudFront Paywall
      • Engage paywall
      • Lua Paywall (deprecated)
    • Project management: A typical project
    • Database dump
    • Debugging
    • Keep your project up-to-date
    • Gulp and Sass
    • Domain mapping
    • Widgets overview
  • Starter kit packages
    • Base package
      • Changelog
    • Boards plugin (EveryBoard)
      • Installation
      • Setup
      • Board Widgets
        • Linked board
        • Template board
        • Embed widget
        • OC List item
        • Content container
      • Teaser templates
      • Actions and filters
      • Export - import
      • Changelog
    • ContentSync plugin
      • Usage
      • Changelog
    • Drop In Plugins package
      • Changelog
    • Everyware plugin
      • Installation
      • Setup
      • Actions and filters
      • Fetching lists and their content
      • Sorting
      • Widgets
      • Changelog
    • Imengine package
      • Helper class: Imengine
      • Changelog
    • NewsML package
      • Idf Parser
      • Changelog
      • Usage
    • NGINX conf package
      • API
      • Changelog
      • Usage
    • Presentation Preview plugin
      • API
      • Changelog
      • Usage
    • Support package
      • Changelog
    • Theme EU resources package*
      • Changelog
    • Theme US resources package
      • Changelog
    • Twig package
      • Development
        • Filters
          • class_string
          • spacey
          • trim_array
        • Functions
          • php_function
          • php_method
          • render_classes
          • render_partial
        • Operators
          • contains
      • Helper classes
        • View
        • ViewSetup
      • Changelog
  • Widgets and component packages
    • Article List widget
      • Installation
      • Using Article List
      • Changelog
    • Menu handler
      • Usage
      • Changelog
    • Section Header widget
      • Changelog
    • Social media icons widget
      • Installation
      • Changelog
    • Google Analytics plugin
      • Set up Google Analytics
      • Most read widget
      • Changelog
    • Redirect Original URLs plugin
      • Installation
      • Changelog
    • Settings Parameters plugin
      • Installation
      • Usage
      • Changelog
  • Design and theme packages
    • Base theme 1
      • Changelog
    • Base theme 2
      • Colors
      • Fonts
      • Header
      • Menus
      • Pages with Board
      • Sidebars
      • Teaser layouts
      • Article page (text)
      • Article page (embeds)
      • Changelog
    • Example theme
      • Changelog
  • MU Plugins
    • Project Plugin
      • Installation
      • Changelog
    • Starter Package Catalyst
    • Concepts
      • Admin Pages
        • All Concepts
        • Add New Concept
        • Types
        • Errors
        • Concept duplicates
      • API
      • Console
      • Changelog
    • Network
      • Changelog
    • Cache Invalidator
      • Getting Started & WP admin
      • Implementation of Lua endpoint
      • Filters
      • Changelog
    • RSS Feeds
      • Setup
      • Administration pages
      • Changelog
  • Services
    • Imengine
    • Imengine documentation
    • Open Content
    • Writer Bookmarklet
Powered by GitBook
On this page
  • Computer hardware and OS
  • Bash
  • Git
  • Docker
  • Node 10 (not required)

Was this helpful?

  1. Developer documentation

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.

PreviousTechnical DetailsNextDeveloper hardware suggestions

Last updated 1 year ago

Was this helpful?

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

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.

Running on Windows requires .

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

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

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

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)

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

PC with Windows: Verify that your Windows version and build match the with: Control Panel > System

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

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

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

requirements for running WSL 2
Docker installed
Node.js version 10
NVM
We have a list with hardware examples, proven to work fine with Naviga Web development.
some extra preparations
Working with git.