Lunaapahkiing Princeton Timetree

License

Content

Site content is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License (CC-BY-NC).

Software

The software for this project is licensed under the Apache 2.0 License.

Developer + contributor setup instructions

For instructions on editing site content, refer to CONTRIBUTING. Local setup is not required for content editing.

Hugo setup

To set the site up locally for development or content editing, first follow the instructions to install Hugo. You can check that Hugo is installed with:

hugo version

This should result in output something like this:

hugo v0.101.0+extended darwin/amd64 BuildDate=unknown

Make sure the version you installed is at least as new as the version shown in the Hugo badge at the top of the project readme (this file).

Once hugo is installed, you'll need to install the javascript dependencies that are used to compile the site's javascript and scss resource files. To check if you have node installed:

node --version

This should output a version string that is at least as new as the version shown in the node badge at the top of this file. To install dependencies, run npm in the project's root directory:

npm install

If the install completes without errors, you're ready to run the site locally.

Serving locally

To run a development server with auto-reload:

hugo server

You should see some debug output, followed by:

Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) Press Ctrl+C to stop

Open a web browser to the above address to see a local version of the site. When you make changes and save files locally, hugo will automatically refresh the page.

Install pre-commmit hooks

Anyone planning to do development on the site (i.e., contributing to javascript, scss, or templates), you need to install pre-commit hooks to automatically ensure tht code is consistently formatted. This step is not required for anyone who is working on site content and not modifying code or templates.

Commit hooks are managed with pre-commit. To install, run:

pre-commit install

Current hooks include Black for python code formatting, isort for standardized python imports, and Prettier for javascript, css, markdown, and other supported file types.

Standardized code styles were instituted after some development was done on this project. To configure git blame to ignore the styling commit, use the following:

git blame <FILE> --ignore-revs-file .git-blame-ignore-revs

Or configure git to always ignore the styling revision commit:

git config blame.ignoreRevsFile .git-blame-ignore-revs