TODO:

• maybe add lighthouse validation checking

  • https://developer.chrome.com/docs/lighthouse/overview/
  • https://github.com/GoogleChrome/lighthouse-ci

---

How to run this application locally

Setup environment

In production (GitHub Actions), environment is setup by by workflows in .github/workflows/.

For local testing (try VS Code + Dev Containers extension, Rancher Desktop), these steps are performed by .devcontainer/ when you run Reopen in Container.

1. Install Ruby (use version in build-test-deploy.yml in "Setup Ruby", (try rbenv)

2. Install Jekyll

   gem update --system
   gem install bundler
   bundle install

3. Install Node & yarn, use version in build-test-publish.yml in "Setup Node.js", (try nvm)

   nvm use 'lts/*'
   yarn install

Build the site

Build the HTML website (see available localhost:#### port in the console output):

bundle exec jekyll build

Serve/run the site

bundle exec jekyll serve

(Bonus) if you will build using Jekyll but deploy to a different server with a script interpreter...

You can run PHP or similar on the built site. Here's how.

(cd build; php -S localhost:4001)

Testing

All testing is performed using Node scripts:

yarn run test