This tutorial will show you how to:
We recommend a modern Unix-like operating system (eg. Ubuntu or OSX). On Windows OS, we suggest using Virtualbox to get a working Linux system.
We use Git as a version control system, so make sure that it’s installed:
$ sudo apt install git # For Debian
$ brew install git # For OSX
We use DDEV to build and manage a Docker-based local development environment. Installing it should just require:
$ curl -LO https://raw.githubusercontent.com/drud/ddev/master/scripts/install_ddev.sh && bash install_ddev.sh
If that doesn’t work, refer to the DDEV Installation instructions.
Finally, make sure to install a local Certificate Authority (CA):
$ mkcert -install
This allows DDEV to provide locally hosted sites under HTTPS without triggering browser warnings.
We use Drumkit to automate common development tasks. Drumkit requires GNU Make, so make sure that it’s installed:
apt install make # For Debian
brew install make # For OSX
For development and testing, this project uses Git submodules. So make sure to use --recursive whenever you clone the project. If you ever forget to, you can always run git submodule update --init from within the project.
git clone --recursive https://gitlab.com/rugged/rugged.git
cd rugged
First, we need to bootstrap Drumkit:
$ . d # on Bash shells
$ source d # on non-Bash shells
N.B. We’re sourcing the file d here. This loads some variables into the environment for this terminal session. You’ll need to run . d (or source d) whenever you want to use Drumkit in a new terminal.
Next, we can start the DDEV Docker containers:
make start