tep-alumni-website

Development Environment

This project relies on Hugo, Yarn, and Node. The asdf version manager is used to install and lock all these tools for both local development and CI.

Basic Dev Instructions

1. Run git submodule update --init --recursive if you haven't already done so
2. Install GNU parallel via brew install parallel (macOS) or from https://savannah.gnu.org/projects/parallel/. 🚨 Do not install the version of 'parallel' provided by 'moreutils'! 🚨
3. Make sure your bash --version > 4
4. Install GPG via brew install gpg2
5. Install asdf (make sure to follow the "Add to your Shell" instructions in the installation guide)
6. Run scripts/asdf-add-plugins.sh to install all the asdf plugins specified in .tool-versions
7. Run asdf install to install all the tool versions specified in .tool-versions
8. Run just install to install of the packages specified in package.json
9. Run just serve to locally serve the site and automatically reload on file changes
10. Run just all (or just just) to
    1. Format and lint all the files in the repository
    2. Render the site to the docs/ folder
    3. Render the CI pipeline to .github/workflows/ci.yaml
11. Create a new branch, commit your changes, and open a pull request. This will run the CI suite which validates your changes.

See https://gohugo.io/documentation/ for more information about Hugo.