www.ccadb.org

Prerequisites

*Note: This website is now on the current version of Ruby 3.1.4 (as of Aug 26, 2023). The prior version, 2.x, was deprecated and no longer receiving important updates and security patches.

Using rbenv (https://github.com/rbenv/rbenv) is an easy way to set up your environment for testing with Ruby, as it allows you to set which version of Ruby you are using.

Installation

Once you've installed rbenv, please be sure to set your environment to use the current version of Ruby 3.1.4, by running:

$ rbenv install 3.1.4
$ rbenv global 3.1.4

Running and testing locally

*Note: Nokogiri strongly recommends using their "native gems," which are precompiled binaries for the specific architecture you'll be running it on. This means you may need to add your architecture to the lockfile if you get errors with Nokogiri. Please see the section below for adding additional platform architectures.

The vendor directory has been removed to comply with best practices, so please run:

$ gem install bundler
$ bundle install
$ bundle exec jekyll serve

This will serve up the website, which you can now visit at: http://127.0.0.1:4000/

Updating in the future

If you need to update github-pages in the future, please follow this guide, or possibly do the following:

$ bundle update github-pages

Adding additional platform architecture support

Currently, the three most common platforms, x86_64-darwin, arm64-darwin, and x86_64-linux are supported. If you'd like to add another architecture, such as aarch64-linux for example, please run the following commands (please reference the link above for your exact platform architecture) and commit the updated lockfile:

$ bundle lock --add-platform aarch64-linux
$ bundle install    # resolve dependencies for platform-specific gems