sdavids.de Homepage

Table of Contents

• 1. Development
  • 1.1. Development Server
    • 1.1.1. Shell 1—​Tailwind CSS CLI build process
    • 1.1.2. Shell 2 - Browsersync process
  • 1.2. Local Build
  • 1.3. Format Source Code
  • 1.4. Lint Source Code
  • 1.5. Run Unit Tests
  • 1.6. Run End-to-End Unit Tests
    • 1.6.1. Running in Headless Mode
    • 1.6.2. Running in Headless Mode With Tracing
    • 1.6.3. Running in UI Mode
• 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. Development Environment Setup
  • 3.1. Installation
    • 3.1.1. DNS
    • 3.1.2. Docker
    • 3.1.3. pnpm
    • 3.1.4. Certificates
    • 3.1.5. jq
    • 3.1.6. brotli
    • 3.1.7. zstd
    • 3.1.8. shellcheck
    • 3.1.9. shfmt
    • 3.1.10. yamllint
    • 3.1.11. hadolint
    • 3.1.12. gpg
    • 3.1.13. easyrsa
    • 3.1.14. Playwright

1. Development

$ cd hp
$ pnpm install

1.1. Development Server

1.1.1. Shell 1—​Tailwind CSS CLI build process

$ cd hp
$ pnpm run dev:css

1.1.2. Shell 2 - Browsersync process

$ cd hp
$ pnpm run dev

⇒ http://localhost:3000

1.2. Local Build

$ cd hp
$ pnpm run build

⇒ hp/dist

1.3. Format Source Code

$ cd hp
$ pnpm run format

1.4. Lint Source Code

$ cd hp
$ pnpm run lint

1.5. Run Unit Tests

$ cd hp
$ pnpm 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
$ pnpm run playwright

1.6.2. Running in Headless Mode With Tracing

Start a development server; in a new shell:

$ cd hp
$ pnpm run playwright:trace

1.6.3. Running in UI Mode

Start a development server; in a new shell:

$ cd hp
$ pnpm run playwright:ui

2. Deployment

2.1. Local Deployment

2.1.1. Create CA and Certificate

$ cd hp
$ pnpm run cert:ca:create
$ pnpm 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
$ pnpm run docker:httpd:start:with-build

⇒ https://httpd.internal:8443

2.1.4. Start Apache HTTPD Without a Build

$ cd hp
$ pnpm run docker:httpd:start

⇒ https://httpd.internal:8443

2.1.5. Stop Apache HTTPD

$ cd hp
$ pnpm 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. pnpm

Install pnpm.

3.1.4. Certificates

New Certificate

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

Existing Certificate

$ cd hp
$ pnpm 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
$ pnpm exec playwright install --with-deps --no-shell

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