Headless framework
Getting started
Installation

Installation

SiteBox based projects require some additional software. As a developer, you probably have some of them installed already. In case you don't, below you will find a list of all dependencies and instructions how to install them.

Prerequisites

Node.js installation

According to Gatsby.js official documentation, Node.js is an environment that can run JavaScript code outside a web browser. Both Gatsby and SiteBox tools are built with Node.js that require at least 14.15 version installed on your machine. Node.js comes bundled with a npm package manager. It will be used to manage packages required by both front-end and back-end environments.

Step one

Manual installation

  • Go to https://nodejs.org/en/download/
  • Download latest LTS installer (be sure that it's labeled LTS as it's most stable version):
  • Launch installer and follow instructions as provided, until Node.Js installation is complete

Installation

Installation via package manager

Step two

Verify installation

  • To check whether your Node.js and npm has been installed properly, run following commands in your terminal:
  • Press Command + Space Bar and type commands node -v and npm -v

Git installation

Git is a version control system that allows to manage changes in the code and help to work on a single project by multiple teammates at the same time. All SiteBox projects use Git for managing code by default.

Step one

In order to install Git on Mac Os, first of all you will need to install Homebrew (package management system for Mac)

  • Press Command + Space Bar and paste /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com /Homebrew/install/HEAD/install.sh)" to the terminal. This command line is responsible for installing Homebrew (screenshot here)
  • Next step is to install newest Git through Homebrew command. Paste brew install git to the terminal. (screenshot here)

Step two

Verify installation

  • To check whether Git has been installed properly, type git --version in the your terminal (screenshot here)

SiteBox CLI

SiteBox CLI is simply a toolset which lets developers streamline repeatable activities by developers within a SiteBox project.

Step one

  • Open terminal
  • Run npm install -g @iamdripfeed/statik-cli inside Git Bash terminal. This command is responsible for installing SiteBox CLI globally (screenshot)

Step two

Verify installation

  • In order to check whether SiteBox CLI has been installed properly, type statik --version inside the Git Bash terminal (screenshot)

Docker

This is an optional dependency that runs WordPress instance locally. In case you would like to develop front-end application with utilisation data of an on-line instance, you can skip this part. In case you would like to use local data in your front-end app, this step is required to spin up LEMP stack that exposes WordPress on your device.

Docker is in fact a service that can virtualize OS-level packages in so-called containers. Each of them is isolated from another, and it is expected to wrap a single functionality by bundling their own software, libraries and configuration files. In the SiteBox JAM Hosting, Docker is used to spin up a linux instance, with a web server nginx, php engine and mysql in exactly the same way, independently to the host operating system.

Step one

SiteBox JAM hostingOverview