coryd.dev/README.md

2.5 KiB

coryd.dev

This is the source for my personal site built using 11ty, PHP and a number of other tools.

Local dev setup

npm run setup

This will generate the required .env file, install dependencies and configure the CLI.

Once the CLI is installed, it is invoked by running coryd.

Remote dev setup

npm run setup:dev

This runs setup and generates apache configs, commands and php extensions to install and enable on the server.

Local dev workflow

  1. coryd run start
  2. Open http://localhost:8080

This will run eleventy --watch and the PHP cli concurrently, allowing for an environment similar to production where both static and dynamic pages are available.

CLI

  • cli init: begins a series of prompts to populate the config used by cli download.
  • cli run: presents a list of commands available to run (described below).
  • cli run [command]: runs the specified command immediately.
  • cli download: presents prompts to download images, name them consistently and place them in the directories specified when running cli init.

Commands

  • coryd run start: primary dev command that runs watch and php concurrently.
  • coryd run start:eleventy: starts 11ty.
  • coryd run start:eleventy:quick: starts 11ty a bit quicker (provided it's already been built).
  • coryd run debug: runs 11ty with additional debug output.
  • coryd run watch: watch and update when files change without running the web server.
  • coryd run build: builds static site output.
  • coryd run php: starts a PHP server for local development.
  • coryd run update:deps: checks for dependency updates and updates 11ty.
  • coryd run clean: removes the dist and .cache folders.
  • coryd run clean:cache: removes the .cache folder.
  • coryd run clean:dist: removes the dist folder.

Required environment variables

POSTGREST_URL              # client + server + build
POSTGREST_API_KEY          # client + server + build
MASTODON_ACCESS_TOKEN      # server
MASTODON_SYNDICATION_TOKEN # server
FORWARDEMAIL_API_KEY       # server
BOOK_IMPORT_TOKEN          # server
WATCHING_IMPORT_TOKEN      # server
TMDB_API_KEY               # server
NAVIDROME_SCROBBLE_TOKEN   # server
NAVIDROME_API_URL          # server
NAVIDROME_API_TOKEN        # server
ARTIST_IMPORT_TOKEN        # server
COOLIFY_REBUILD_TOKEN      # server
COOLIFY_REBUILD_URL        # server
GIT_REPO                   # build
SERVER_URL                 # build