sdavids.de Homepage

Table of Contents

1. Development
2. Deployment
- 2.1. Local Deployment
- 2.2. Deployment to sdavids.de
3. Development Environment Setup
- 3.1. Installation

1. Development

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

1.1. Development Server

1.1.1. Shell 1 - Tailwind CSS CLI build process

$ cd hp
$ node --run dev:css

1.1.2. Shell 2 - Browsersync process

$ cd hp
$ node --run dev

⇒ http://localhost:3000

1.2. Local Build

$ cd hp
$ node --run build

⇒ hp/dist

ℹ️

.../sdavids.de-homepage/hp/node_modules/.bin/lightningcss: line 1: This: command not found

This build relies on esbuild and lightningcss.

You either need to not ignore the pre- or post-scripts when installing this project’s dependencies:

$ cd hp
$ rm -rf node_modules
$ npm install --no-ignore-scripts

Or invoke esbuild’s and lightningcss' post-install scripts explicitly:

$ cd hp
$ node node_modules/esbuild/install.js
$ node node_modules/lightningcss-cli/postinstall.js

1.3. Format Source Code

$ cd hp
$ node --run format

1.4. Lint Source Code

$ cd hp
$ node --run lint

1.5. Run Unit Tests

$ cd hp
$ node --run test

1.6. Run End-to-End Unit Tests

ℹ️	Ensure Playwright has been installed.

1.6.1. Running in Headless Mode

Start a development server; in a new shell:

$ cd hp
$ npm run e2e

1.6.2. Running in Headless Mode With Tracing

Start a development server; in a new shell:

$ cd hp
$ npm run e2e:trace

1.6.3. Running in UI Mode

Start a development server; in a new shell:

$ cd hp
$ npm run e2e:ui

2. Deployment

2.1. Local Deployment

2.1.1. Create CA and Certificate

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

❗	Ensure that you have modified your DNS settings to include `httpd.internal`.

2.1.2. Create Base Docker Image

$ cd httpd
$ scripts/docker_build.sh

2.1.3. Build And Start Apache HTTPD

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

⇒ https://httpd.internal:8443

2.1.4. Start Apache HTTPD Without a Build

$ cd hp
$ node --run docker:httpd:start

⇒ https://httpd.internal:8443

2.1.5. Stop Apache HTTPD

$ cd hp
$ node --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. Development Environment Setup

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

3.1. Installation

3.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",
…
  },
…

3.1.2. Docker

Install Docker.

3.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

3.1.4. Certificates

New Certificate

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

Existing Certificate

$ cd hp
$ node --run cert:copy

3.1.5. jq

Linux

$ sudo apt-get install jq

Mac

$ brew install jq

3.1.6. brotli

Linux

$ sudo apt-get install brotli

Mac

$ brew install brotli

3.1.7. zstd

Linux

$ sudo apt-get install zstd

Mac

$ brew install zstd

3.1.8. shellcheck

Linux

$ sudo apt-get install shellcheck

Mac

$ brew install shellcheck

3.1.9. shfmt

Linux

$ sudo apt-get install shfmt

Mac

$ brew install shfmt

3.1.10. yamllint

Linux

$ sudo apt-get install yamllint

Mac

$ brew install yamllint

3.1.11. hadolint

Linux

Install hadolint.

Mac

$ brew install hadolint

3.1.12. gpg

Linux

$ sudo apt-get install gpg

Mac

Install GPG Suite.

3.1.13. easyrsa

❗	Ensure that you install version `3.1.7` and not `3.2.x`!

Linux

Install easyrsa.

Mac

Warning

Unfortunately, homebrew provides easy-rsa version 3.2.x .

$ 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
$ rm ~/Downloads/easy-rsa.tgz

3.1.14. Playwright

$ cp hp
$ npx playwright install --with-deps --no-shell

ℹ️	You can delete all downloaded binaries via: $ npx playwright uninstall --all

Name		Name	Last commit message	Last commit date
Latest commit History 1,014 Commits
.devcontainer		.devcontainer
.github		.github
LICENSES		LICENSES
design		design
hp		hp
httpd		httpd
scripts		scripts
.editorconfig		.editorconfig
.git-blame-ignore-revs		.git-blame-ignore-revs
.gitattributes		.gitattributes
.gitignore		.gitignore
.hadolint.yaml		.hadolint.yaml
.yamllint.yaml		.yamllint.yaml
README.adoc		README.adoc
REUSE.toml		REUSE.toml
TODO.adoc		TODO.adoc

sdavids/sdavids.de-homepage

Folders and files

Latest commit

History

Repository files navigation

sdavids.de Homepage

About

Resources

Stars

Watchers

Forks

Languages