Horses website (🔨 UPDATE THIS AFTER YOU COPY TEMPLATE)

Updating content

🔨 Add specific notes here about content style guides or how contributors can work together to update content on your site.

How to build this website locally

Setup local environment

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

Use VS Code and the Dev Containers extension, install a Docker host (on Mac, use OrbStack) then run VS Code command "Reopen in Container".

Or if you do not want VS Code or the Docker setup, install your environment manually:

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-deploy.yml in "Setup Node.js", (try nvm):

   nvm install --lts --reinstall-packages-from=current
   nvm use --lts
   yarn install

Build the site

Build the HTML website.

bundle exec jekyll build

Access your site at http://127.0.0.1:4000 (or see other "server address" in console output).

Serve/run the site

bundle exec jekyll serve --livereload

Linting

Perform code linting (this does not require building the site):

yarn lint

And automatically fix with:

yarn lint-fix

Testing

Perform website testing (you must have already built the site)

yarn test

Notes for VS Code

Open this folder in VS Code, allow the "Reopen in Container" and install recommended extensions.

This will give you formatting, linting, and other tools to help you develop.

Maintenance: updating dependencies

Do this every month or so and please send a PR here if you see updates available:

yarn set version latest && yarn # Send PR
yarn upgrade-interactive # Send PR

Also you can run this to update your environment to match the GitHub Pages (no PR, this is in .gitignore):

bundle update --conservative # "--consersative" ignores updates that GitHub Pages is not using

References

1. This website is built based on best practices documented in github-pages-template.
2. Setting up Docker
   1. We would prefer an open-source-licensed Docker implementation that runs at native speed on Mac, Linux and Windows. For Mac, you may prefer to install Colima which is open source but about 5x slower than the OrbStack recommended above.
3. We use the github-pages gem instead of Jekyll because GitHub Pages uses those specific versions instead of what is in your Gemfile.lock. This is also why we add Gemfile.lock to .gitignore.