Environment Setup

Local development environment configuration guide.

Overview

This guide will help you get our documentation (Hugo) website running locally for development and contribution.

Prerequisites: Before beginning, ensure you’ve completed the GitLab setup in our handbook, including SSH key configuration and repository access.

Step 1: Install Required Tools

macOS:

brew install hugo git go

export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin

source ~/.zshrc  # or source ~/.bashrc

Windows:

Download Hugo from releases page
Download Git from git-scm.com
Download Go from golang.org/dl
Add all tools to your PATH environment variable

Linux:

sudo snap install hugo
sudo apt install git

Purpose: Installs Hugo (static site generator), Git (version control), and Go (required for Hugo modules) needed for the project.

Note: The Linux snap version includes Go bundled, so no separate Go installation is needed.

Step 2: Clone and Setup Repository

Clone the repository:

mkdir group-bwrgy
cd group-bwrgy
git clone git@gitlab.com:bwrgy/core/handbook.git
cd handbook

Purpose: Creates organized directory structure, clones the specific repository using SSH authentication, and navigates into the project folder.

Start the development server:

hugo server

Purpose: Starts a local development server so you can preview the site and see changes in real-time.

Step 3: Verify Setup

Open http://localhost:1313 in your browser. The site should load without errors.

Test live reloading: Make some changes inside the content/ folder and save—you should see the changes appear instantly in your browser without refreshing.

When hugo server runs successfully and you can browse the site locally, you’re ready to contribute!