bcm

This repository contains my public website, other projects I've worked on, and some self-hosted systems.

Structure

• .github/workflows - GitHub Actions workflows to deploy apps and infrastructure.
• .vscode - Customised VS Code project configuration.
• .zed - Customised Zed Editor project configuration.
• bin - Supporting tools and scripts.
• docs - Documentation and contextual information.
• docs/adrs - Architecture decision records in Markdown files.
• docs/AI-USE.md - Policy for use of AI Code Generation tools.
• design - Page layout and icon design files.
• src/git - A self-hosted version of the Forgejo Git service.
• src/links - A self-hosted version of the Karakeep bookmarking service.
• src/schnitmydadsays - Schnitzel review website.
• src/site - My main public website at bcm.works.
• src/upcomingtasks - A web-based Basecamp 2 client.
• storage - Used for persistent storage by local Docker containers.
• .editorconfig - Sets basic code style rules via EditorConfig
• justfile - Project specific commands for Just

Local Setup

The systems in this repository assume that your local machine:

• Is running a Debian-based Linux OS
• Has an up-to-date version of Docker CLI installed and ready
• Has an up-to-date version of Deno installed and ready
• Has an up-to-date version of Just installed and ready
• Has an up-to-date version of Homebrew installed and ready
• Has an up-to-date version of GitHub CLI installed and ready

Note that my dotfiles repository contains install scripts for most of the above items.

Local Tools

Run bin/setup-local.sh to setup your local environment.

bash ./bin/setup-local.sh

This repository uses Just to run commands defined in justfile.

These commands can be run in a Terminal session from any sub-directory of the repository.

To list all of the available options, run:

just list