sdavids.de Homepage

Table of Contents

• 1. Development
  • 1.1. Shell 1 - Tailwind CSS CLI build process
  • 1.2. Shell 2 - Browsersync process
  • 1.3. Format Source Code
  • 1.4. Lint Source Code
• 2. Deployment
  • 2.1. Local Deployment
    • 2.1.1. Create CA and Certificate
    • 2.1.2. Create Base Docker Image
    • 2.1.3. Build And Start Apache HTTPD
    • 2.1.4. Start Apache HTTPD Without a Build
    • 2.1.5. Stop Apache HTTPD
  • 2.2. Deployment to sdavids.de
• 3. License
• 4. Contribution
• 5. Code of Conduct
• 6. Development Environment Setup
  • 6.1. Installation
    • 6.1.1. DNS
    • 6.1.2. Docker
    • 6.1.3. Node Version Manager
    • 6.1.4. Certificates
    • 6.1.5. jq
    • 6.1.6. brotli
    • 6.1.7. zstd
    • 6.1.8. shellcheck
    • 6.1.9. shfmt
    • 6.1.10. yamllint
    • 6.1.11. hadolint
    • 6.1.12. gpg
    • 6.1.13. easyrsa

1. Development

$ cd hp
$ npm install --no-ignore-scripts

1.1. Shell 1 - Tailwind CSS CLI build process

$ cd hp
$ npm run dev:css

1.2. Shell 2 - Browsersync process

$ cd hp
$ npm run dev

⇒ http://localhost:3000

1.3. Format Source Code

$ cd hp
$ npm run format

1.4. Lint Source Code

$ cd hp
$ npm run lint

2. Deployment

2.1. Local Deployment

2.1.1. Create CA and Certificate

$ cd hp
$ npm run cert:ca:create
$ npm run cert:create

2.1.2. Create Base Docker Image

$ cd httpd
$ scripts/docker_build.sh

2.1.3. Build And Start Apache HTTPD

$ cd hp
$ npm run docker:httpd:start:with-build

⇒ https://httpd.internal:8443

2.1.4. Start Apache HTTPD Without a Build

$ cd hp
$ npm run docker:httpd:start

⇒ https://httpd.internal:8443

2.1.5. Stop Apache HTTPD

$ cd hp
$ npm run docker:httpd:stop

2.2. Deployment to sdavids.de

Deployed website

sdavids.de.

GitHub Action Workflow

.github/workflows/ci.yaml

GitHub Action Runs

github.com/sdavids/sdavids.de-homepage/actions

3. License

Apache License, Version 2.0 (Apache-2.0.txt or www.apache.org/licenses/LICENSE-2.0).

4. Contribution

See CONTRIBUTING.adoc.

5. Code of Conduct

We abide by the Contributor Covenant, Version 2.1 and ask that you do as well.

For more information, please see Code of Conduct.

6. Development Environment Setup

❗	After initializing this repository you need to configure the ignore-revs-file: $ git config blame.ignoreRevsFile .git-blame-ignore-revs

6.1. Installation

6.1.1. DNS

Add httpd.internal to your /etc/hosts:

/etc/hosts

127.0.0.1       localhost httpd.internal
::1             localhost httpd.internal

ℹ️

If you want to change this entry you need to also change: httpd/httpd.conf ServerName httpd.internal:80 httpd/httpd-ssl.conf ServerName httpd.internal:443 hp/scripts/docker_httpd_start.sh readonly host_name='httpd.internal' hp/package.json … "scripts": { … "cert:copy": "scripts/copy_ca_based_cert.sh certs httpd.internal", "cert:create": "scripts/create_ca_based_cert.sh certs 30 httpd.internal", "cert:delete": "scripts/delete_ca_based_cert.sh certs httpd.internal", "cert:renew": "scripts/renew_ca_based_cert.sh certs 30 httpd.internal", "cert:verify": "scripts/verify_ca_based_cert.sh certs 30 httpd.internal", … }, …

6.1.2. Docker

Install Docker.

6.1.3. Node Version Manager

Install fnm or NVM.

ℹ️	This repository uses husky for Git hooks. More information: Husky - Command not found

fnm

~/.zprofile

if command -v fnm >/dev/null 2>&1; then
  eval "$(fnm env --use-on-cd)"
fi

~/.config/husky/init.sh

#!/usr/bin/env sh

# vim:ft=zsh

# shellcheck shell=sh disable=SC1091

set -eu

[ -e /etc/zshenv ] && . /etc/zshenv
[ -e "${ZDOTDIR:=${HOME}}/.zshenv" ] && . "${ZDOTDIR:=${HOME}}/.zshenv"
[ -e /etc/zprofile ] && . /etc/zprofile
[ -e "${ZDOTDIR:=${HOME}}/.zprofile" ] && . "${ZDOTDIR:=${HOME}}/.zprofile"
[ -e /etc/zlogin ] && . /etc/zlogin
[ -e "${ZDOTDIR:=${HOME}}/.zlogin" ] && . "${ZDOTDIR:=${HOME}}/.zlogin"

nvm

~/.zshrc

export NVM_DIR="${HOME}/.nvm"

[ -s "${NVM_DIR}/nvm.sh" ] && . "${NVM_DIR}/nvm.sh"
[ -s "${NVM_DIR}/bash_completion" ] && . "${NVM_DIR}/bash_completion"

if command -v nvm >/dev/null 2>&1; then
  autoload -U add-zsh-hook
  load-nvmrc() {
    local nvmrc_path="$(nvm_find_nvmrc)"
    if [ -n "${nvmrc_path}" ]; then
      local nvmrc_node_version=$(nvm version "$(cat "${nvmrc_path}")")
      if [ "${nvmrc_node_version}" = "N/A" ]; then
        nvm install
      elif [ "${nvmrc_node_version}" != "$(nvm version)" ]; then
        nvm use
      fi
    elif [ -n "$(PWD=$OLDPWD nvm_find_nvmrc)" ] && [ "$(nvm version)" != "$(nvm version default)" ]; then
      echo 'Reverting to nvm default version'
      nvm use default
    fi
  }

  add-zsh-hook chpwd load-nvmrc
  load-nvmrc
fi

~/.config/husky/init.sh

#!/usr/bin/env sh

# vim:ft=zsh

# shellcheck shell=sh disable=SC1091

set -eu

[ -e /etc/zshenv ] && . /etc/zshenv
[ -e "${ZDOTDIR:=${HOME}}/.zshenv" ] && . "${ZDOTDIR:=${HOME}}/.zshenv"
[ -e /etc/zprofile ] && . /etc/zprofile
[ -e "${ZDOTDIR:=${HOME}}/.zprofile" ] && . "${ZDOTDIR:=${HOME}}/.zprofile"
[ -e /etc/zlogin ] && . /etc/zlogin
[ -e "${ZDOTDIR:=${HOME}}/.zlogin" ] && . "${ZDOTDIR:=${HOME}}/.zlogin"

export NVM_DIR="${HOME}/.nvm"

if [ -f "${NVM_DIR}/nvm.sh" ]; then
  . "${NVM_DIR}/nvm.sh"

  if [ -f '.nvmrc' ]; then
    nvm use
  fi
fi

6.1.4. Certificates

New Certificate

$ cd hp
$ node --run cert:ca:create
$ node --run cert:create

Existing Certificate

$ cd hp
$ node --run cert:copy

6.1.5. jq

Linux

$ sudo apt-get install jq

Mac

$ brew install jq

6.1.6. brotli

Linux

$ sudo apt-get install brotli

Mac

$ brew install brotli

6.1.7. zstd

Linux

$ sudo apt-get install zstd

Mac

$ brew install zstd

6.1.8. shellcheck

Linux

$ sudo apt-get install shellcheck

Mac

$ brew install shellcheck

6.1.9. shfmt

Linux

$ sudo apt-get install shfmt

Mac

$ brew install shfmt

6.1.10. yamllint

Linux

$ sudo apt-get install yamllint

Mac

$ brew install yamllint

6.1.11. hadolint

Linux

Install hadolint.

Mac

$ brew install hadolint

6.1.12. gpg

Linux

$ sudo apt-get install gpg

Mac

Install GPG Suite.

6.1.13. easyrsa

❗	Ensure that you install version 3.1.7 and not 3.2.0! Version 3.2.0 is an incompatible development snapshot release.

Linux

Install easyrsa.

Mac

Warning

Unfortunately, homebrew provides easy-rsa version 3.2.0 at this point in time (August 2024).

$ curl -L https://github.com/OpenVPN/easy-rsa/releases/download/v3.1.7/EasyRSA-3.1.7.tgz -o ~/Downloads/easy-rsa.tgz
$ tar -xzf ~/Downloads/easy-rsa.tgz -C ~/.local/share
$ mv  ~/.local/share/EasyRSA-3.1.7 ~/.local/share/easyrsa
$ ln -s ~/.local/share/easyrsa/easyrsa ~/.local/bin/easyrsa