Faircamp

Faircamp on macOS

Get started on macOS

Tutorial Overview

This tutorial will guide you through installing faircamp, generating your first faircamp site, customizing it further through the use of manifests, and finally show you one (of many) ways to publish your site online.

Note that there also other great tutorials around, such as Meljoann's faircamp introduction (for all platforms), LinuxCreative's video guide (for Linux) and Johann Bourquenez's french faircamp tutorial (for all platforms). You can also mix and match these, each has its own style and covers different aspects more thorougly, but the approach is always the same and thus fully compatible.

Install faircamp

On macOS, faircamp is currently distributed through the Homebrew package manager, which you first need to install.

At brew.sh you find installation instructions for Homebrew - it can be installed either using the .pkg installer or through the terminal.

When you have installed homebrew, you can install faircamp by opening a terminal and executing the command brew install faircamp.

It actually works the same everywhere!

Asides the installation and a few gotchas, faircamp actually works 100% the same on all platforms! For this reason, producing screencasts and writing out the instructions again for each and every platform does not add much, while it would however take a lot of time that could otherwise be spent on development and new features! Consequently for now - and I hope you agree with the reasoning for this choice! :) - the macOS tutorial merely points out the two key differences on macOS, and then takes you to the Windows tutorial for following all steps (which work just the same on macOS).

The only two differences worth noting:

  1. Instead of the Windows File Explorer, Command Prompt and Notepad, you'll be using your native macOS counterparts. These are the Finder, the terminal and a (plain text preserving!) text editor - if you want to use the native TextEdit application, make sure to set Plain Text as the default format (under Preferences > Format) before beginning the tutorial.
  2. In the (Windows) tutorial you will see commands like faircamp.exe --preview or faircamp.exe --preview --theming-widget. On macOS, remove/omit the .exe in every command, so that your commands look like this instead: faircamp --preview or faircamp --preview --theming-widget
And that's all! With these hints in mind follow along with the Windows Tutorial and you'll be done in no time!