Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brendanmurty/site

Murty family website
https://github.com/brendanmurty/site

deno github-actions github-pages javascript nunjucks static-site tsx typescipt

Last synced: 6 days ago
JSON representation

Murty family website

Awesome Lists containing this project

README 

        
# Murty Website



[ ![Deployment Status](https://img.shields.io/github/actions/workflow/status/brendanmurty/site/release.yml?label=Deployment%20Status&style=flat-square&labelColor=%23222222)](https://github.com/brendanmurty/site/actions/workflows/release.yml)

[ ![Latest Release](https://img.shields.io/github/v/release/brendanmurty/site?label=Latest%20Release&style=flat-square&color=%2323c5b0&labelColor=%23222222)](https://github.com/brendanmurty/site/releases)

[ ![Website Status](https://img.shields.io/website?url=https%3A%2F%2Fmurty.au&up_message=online&down_message=offline&style=flat-square&logo=globe&label=Website%20Status&labelColor=%23222222)](https://murty.au)



## Summary



This repository contains the website for the [Murty family](https://murty.au/), which has been built with [Deno](https://deno.land/), [Lume](https://lumeland.github.io/), a commercially licensed version of the [IO font by Mass-Driver](https://io.mass-driver.com/), and a licensed icon pack from [Font Awesome](https://fontawesome.com/).



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



Remote testing and [GitHub Pages](https://pages.github.com/) deployment can be triggered locally and is then handled remotely by a [GitHub Actions workflow](.github/workflows/release.yml).



### Previews of the home page



![Preview of the home page in dark mode](assets/docs/home-dark.png)



![Preview of the home page in light mode](assets/docs/home-light.png)



### Lighthouse test results



[![Lighthouse test results](assets/docs/lighthouse-performance-test-results.png)](https://pagespeed.web.dev/analysis/https-murty-au/463mvuyx3j?form_factor=desktop)



## Initial setup



1. Fork this repository

2. Make a local clone of that forked repository

3. Install the latest stable version of [Deno](https://deno.com/)

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

- Update `.github/workflows/release.yml` to use your own Docker Hub 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](https://io.mass-driver.com/) or update the CSS to use other fonts

- Purchase [Font Awesome Pro](https://fontawesome.com/), setup your own kit, and update the `kit.fontawesome.com` script path in the source code. Alternatively, you can use a free icon pack and update the code in your fork to use that instead.



6. Commit and push all of these changes to your forked repository

7. Update the Settings for your forked repository via GitHub:



- Pages > Source: _GitHub Actions_

- Pages > Custom domain: _use your own domain_

- Secrets and variables > Actions > new secret > Name: `DOCKERHUB_USERNAME`, Secret: _your Docker username_

- Secrets and variables > Actions > new secret > Name: `DOCKERHUB_TOKEN`, Secret: _[generate new token](https://app.docker.com/settings/personal-access-tokens), read and write permissions, save the generated token here_



8. Update `config/CNAME` to use the same domain as you configured above

9. Setup [Fathom Analytics](https://usefathom.com/):



- Create your own account and setup a new site

- Update your `.env` file's `FATHOM_ANALYTICS_SITE_ID` value to use your new `Site ID`



10. **Optional:** Install [VS Code](https://code.visualstudio.com/) and add the [Deno](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno) plugin



## Commands



| Command | Description |

| ---- | ---- |

| `deno task build`                      | Run build processes |

| `deno task test`  | Run all tests |

| `deno task serve` | Start a local web server. Builds the site and starts a local web server at `http://localhost:8000/` |

| `deno task release` | Generate and push a new Git Tag, which will then trigger the [GitHub Actions workflow](.github/workflows/release.yml) in the remote repository. |



_Refer to the `tasks` section in [deno.json](deno.json) for the full list of commands._



## Folder structure and key files



| Folder / File | Description |

| ---- | ---- |

| [.github/workflows/release.yml](.github/workflows/release.yml) | Triggers when a release tag is pushed. Runs tests, deploys to [GitHub Pages](https://pages.github.com/), publishes a new [GitHub release](https://github.com/brendanmurty/site/releases) and pushes a new version to the [repository on Docker Hub](https://hub.docker.com/r/brendanmurty/site). |

| [.vscode](.vscode/) | Customised [VS Code](https://code.visualstudio.com/) configuration for this repository. |

| [assets](assets/) | Static files like images and PDFs. |

| [config](config) | Supporting configuration files. |

| [content](content/) | Website page content in [Markdown](https://daringfireball.net/projects/markdown/syntax) files. |

| [src](src/) | Source code and related unit tests. |

| [src/commands](src/commands) | Helper scripts, refer to the `Commands` section above for more details. |

| [src/layouts](src/layouts) | React TSX page layouts. |

| [src/styles](src/styles) | CSS styles. |

| [src/templates](src/templates) | Nunjucks page templates. |

| [deno.json](deno.json) | [Deno](https://deno.land/) imports, tasks and configuration for this repository. |