Murty Website

Summary

This repository contains the murty.au website, which has been built with Deno, Lume, a licensed version of the IO font by Mass-Driver, and the free Font Awesome icon pack.

Tests, build and local server commands are available from local environments.

Releases can be manually triggered via the Release GitHub Action Workflow, which includes checking the test and build processed work before starting a new deployment Deno Deploy. It then publishes a new GitHub Release.

Third-party dependencies are kept up to date via a scheduled GitHub Action Workflow, which can also be triggered manually. If there are changes, it confirms they don't break tests or builds, then creates a Pull Request.

Structure

• .github/workflows/dependencies.yml - Automatic dependency upgrade workflow.
• .github/workflows/release.yml - Release and deployment workflow.
• .vscode - Customised VS Code project configuration.
• .zed - Customised Zed Editor project configuration.
• assets - Static files like images and PDFs.
• bin - Bash helper scripts, run deno task to show available options.
• config - Supporting configuration files.
• content - Website page content in Markdown files.
• src - Source code and related unit tests.
• src/layouts - Nunjucks page layouts.
• src/styles - CSS styles.
• src/templates - Nunjucks page templates.
• AGENTS.md - AI Agent instructions, technical docs and guidance.
• deno.json - Deno imports, tasks and configuration.

Initial Setup

1. Fork this repository
2. Make a local clone of that forked repository
3. Install the latest stable release of Deno
4. Run the setup script: deno task setup
5. Update some files in the forked repository

• Update .github/workflows/release.yml to use your forked GitHub repository URL
• All files in the content directory must contain your own content instead
• All files in the assets directory must contain your own static files instead
• Purchase your own license to use the Mass-Driver IO font or update the CSS to use other fonts

6. Commit and push all of these changes to your forked repository
7. Setup your own Deno Deploy Org, Project and Personal Access Token
8. Update the Settings for your forked repository via GitHub:

• Go to Settings > Security > Secrets and variables > Actions
• Add new Repository secrets for the variables in .env.github.example
• Update the deploy section in deno.json to use your own Deno Deploy org and app

9. Setup Fathom Analytics:

• Create a new site in your own account
• Update your .env file's FATHOM_SITE_CODE value to use your new Fathom Site ID