Skip to content

oszuidwest/streekomroep-wp

Repository files navigation

The Streekomroep WordPress Theme

This is a WordPress theme created for Streekomroep ZuidWest in the Netherlands. It utilizes Timber and Tailwind CSS, offering functionality for regional news, radio, and TV broadcasts. Use it with WordPress 6.5+ and PHP 8.1+.

How to build/install

Instructions for macOS:

  • Install Homebrew (https://brew.sh)
  • Install Composer and Node with brew install composer node
  • Download the theme from GitHub to a local folder
  • Open the folder in a terminal and execute the following commands:
npm install
NODE_ENV=production npx tailwindcss build assets/style.css -o dist/style.css --minify
composer install --prefer-dist --no-dev --optimize-autoloader
  • Upload the theme to /wp-content/themes/ and activate it.

For Linux users, use apt or yum instead of Homebrew. This theme has not been tested on Windows, but should work if your Composer and Node versions are up-to-date. To build remotely, consider using GitHub Actions or Buddy CI/CD for the building and uploading process.

Hard dependencies

Install these before activating the theme:

Soft dependencies

These tested plugins enhance the theme:

Extra functionality with first-party plugins

Some first-party plugins developed by Streekomroep ZuidWest add extra functionality to this theme. They are optional and can be installed separately:

  • ZuidWest Webapp [on GitHub]: Adds push messages and functionality for a progressive web app using the service Progressier.
  • Tekst TV GPT [on GitHub]: Adds a button that generates 'tekst tv' summaries for articles using OpenAI GPT models.

What's here?

static/: Store your static front-end scripts, styles, or images here, including Sass files, JS files, fonts, and SVGs.

templates/: Contains all Twig templates, corresponding closely with the PHP files in the WordPress template hierarchy. Each PHP template ends with a Timber::render() function, linking to the Twig file where the data (or $context) is used.