Setup Locally
Prerequisites
IDE
We recommend using VSCodium (no telemetry version of VSCode) for development.
Git
Install the version control system for your operating system:
Linux:
# Debian/Ubuntu
sudo apt install git -y
# Fedora
sudo dnf install git -yWindows: Download from git-scm.com and run the installer.
MacOS: Using Homebrew:
brew install gitOr download from git-scm.com
Hugo (Extended Version)
Install Hugo v0.145.0 or later (extended version required):
Linux:
sudo apt install hugoOr
wget https://github.com/gohugoio/hugo/releases/download/v0.145.0/hugo_extended_0.145.0_linux-amd64.deb
sudo dpkg -i hugo_extended_0.145.0_linux-amd64.debWindows: Using Chocolatey (admin PowerShell):
choco install hugo-extended -yOr download from GitHub Releases
MacOS: Using Homebrew:
brew install hugoGo
Install Go 1.20:
Linux:
# Download and extract
wget https://go.dev/dl/go1.20.linux-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.20.linux-amd64.tar.gz
# Add to PATH (add to ~/.bashrc or ~/.zshrc)
echo 'export PATH=$PATH:/usr/local/go/bin' >> ~/.bashrc
source ~/.bashrcWindows:
Download the installer from go.dev/dl and run it.
Alternatively, using Chocolatey:
choco install golang --version=1.20 -yMacOS: Using Homebrew:
brew install go@1.20
# Link it into PATH
echo 'export PATH=$(brew --prefix go@1.20)/bin:$PATH' >> ~/.zshrc
source ~/.zshrcOr download from go.dev/dl.
Download & Run Beginner Privacy
Clone the repository:
git clone https://github.com/beginnerprivacy/beginnerprivacy.com
cd beginnerprivacy.comStart development server:
hugo server
The site will be available at:
http://localhost:1313/
Note: Use Ctrl+C to stop the server.
Git Commit Message Guidelines
Follow these conventions for commit messages:
Format:
<type>: <subject>
Example:
docs: Add local setup instructions
Requirements:
- Use present tense (e.g., “Add” not “Added”)
- Keep subject line under 72 characters
Types:
- chore: General changes
- feat: New feature
- fix: Bug fix
- docs: Documentation changes
- article: Article changes
- checklist: Checklist changes
- style: Formatting changes
- refactor: Code restructuring