Merge pull request #5 from simonprydden/4-add-local-development-setup

add local development environment

Author: simonprydden

README.md

@@ -1 +1,61 @@
-# simonprydden.github.io
+# Personal Handbook  
+
+## About  
+
+This repository contains the documentation for my personal website, built using [Docusaurus](https://docusaurus.io/). 
+The site is deployed via GitHub Pages and can be accessed at [simonprydden.github.io](https://simonprydden.github.io/).  
+
+## Features  
+- **Built with Docusaurus**: A modern, React-based static site generator.  
+- **GitHub Pages Deployment**: Automatic deployment after changes are merged into the repository.  
+- **Customizable Content**: Easily add or edit `.md` files for documentation and blogs.  
+
+---
+
+## Installation  
+
+### Prerequisites  
+
+Before starting, ensure the following tools are installed:  
+- **Docker Compose**: Follow the [official installation guide](https://docs.docker.com/compose/install/).  
+- **Docker Engine**: Install it using the [official installation guide](https://docs.docker.com/engine/install/).  
+
+### Getting Started  
+
+1. Clone the repository:  
+   ```bash  
+   git clone https://github.com/simonprydden/simonprydden.github.io.git  
+   ```  
+2. Navigate to the project directory:  
+   ```bash  
+   cd simonprydden.github.io  
+   ```  
+
+---
+
+## Local Development  
+
+To preview and develop the site locally:  
+
+1. Start the development server:  
+   ```bash  
+   make start  
+   ```  
+   This command will spin up a local Docusaurus server, typically accessible at `http://localhost:3000`.  
+
+2. Add or edit content:  
+   - Add documentation in the `docs` directory.  
+   - Write blog posts in the `blog` directory.  
+
+3. Preview your changes in real time.  
+
+---
+
+## Deployment  
+
+To publish your changes:  
+
+1. Test your changes locally to ensure everything works as expected.  
+2. Open a Pull Request (PR) to submit your updates for review.  
+3. After the PR is reviewed and merged, your changes will be automatically deployed to [simonprydden.github.io](https://simonprydden.github.io/).  
+

docker-compose.yaml

@@ -0,0 +1,13 @@
+name: "docusaurus"
+services:
+  dev:
+    build:
+      context: .
+      dockerfile: docker/dockerfile
+      target: dev
+    ports:
+      - "3000:3000"
+    volumes:
+      - ./website:/opt/docusaurus
+    environment:
+      - NODE_ENV=development

docker/dockerfile

@@ -0,0 +1,35 @@
+# Stage 1: Base image.
+FROM node:lts AS base
+
+## Disable colour output from yarn to make logs easier to read.
+ENV FORCE_COLOR=0
+RUN corepack enable
+WORKDIR /opt/docusaurus
+
+# Stage 2a: Development mode.
+FROM base AS dev
+WORKDIR /opt/docusaurus
+EXPOSE 3000
+## Run the development server.
+CMD [ -d "node_modules" ] && npm run start -- --host 0.0.0.0 --poll 1000 || npm install && npm run start -- --host 0.0.0.0 --poll 1000
+
+# Stage 2b: Production build mode.
+FROM base AS prod
+WORKDIR /opt/docusaurus
+## Copy over the source code.
+COPY ./website /opt/docusaurus/
+RUN npm ci
+RUN npm run build
+
+# Stage 3a: Serve with `docusaurus serve`.
+FROM prod AS serve
+EXPOSE 3000
+## Run the production server.
+CMD ["npm", "run", "serve", "--", "--host", "0.0.0.0", "--no-open"]
+
+# Stage 3b: Serve with Caddy.
+FROM caddy:2-alpine AS caddy
+## Copy the Caddyfile.
+COPY --from=prod /opt/docusaurus/Caddyfile /etc/caddy/Caddyfile
+## Copy the Docusaurus build output.
+COPY --from=prod /opt/docusaurus/build /var/docusaurus

makefile

@@ -0,0 +1,32 @@
+# Targets
+.PHONY: help start stop clean
+
+SHELL := /bin/bash
+
+help:
+	@echo "Usage: make <target>"
+	@echo ""
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$|(^#--)' $(MAKEFILE_LIST) \
+	| grep -v '^\(include\|[A-Z_]\+\s*=\)' \
+	| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m %-43s\033[0m %s\n", $$1, $$2}' \
+	| sed -e 's/\[32m #-- /[33m/'
+
+#-- Docker
+start: ## Start the docusaurus services
+	@echo "Starting docusaurus services..."
+	docker compose up -d
+
+stop: ## Stop the docusaurus services
+	@echo "Stopping docusaurus services..."
+	docker compose stop
+
+clean: ## Remove all Docker containers, networks, and volumes
+	@echo "Cleaning up docusaurus resources..."
+	docker compose down -v --remove-orphans
+
+#-- Utilities
+open: ## Open the Docusaurus site in the default web browser
+	@echo "Opening Docusaurus site..."
+	xdg-open http://localhost:3000 2>/dev/null || \
+	open http://localhost:3000 2>/dev/null || \
+	start http://localhost:3000