Custom, lean WordPress theme for the tm.id.au static site.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
content
inc
src
templates
tests
.deploy.sh
.eslintrc.js
.gitignore
.stylelintrc.js
.travis.yml
404.php
LICENSE
README.md
composer.json
composer.lock
footer.php
functions.php
header.php
index.php
package.json
phpcs.xml
phpunit.xml
sidebar.php
style.css
webpack.config.js
yarn.lock

README.md

tm.id.au

Custom, lean WordPress theme for tm.id.au.

Designed to be converted to a static site with the Simply Static plugin.

Installation

From your wp-content/themes directory, run:

git clone https://github.com/tdmalone/tm-id-au.git
cd tm-id-au
yarn
yarn build

Then activate the theme via Appearance -> Themes in WordPress admin.

Building, Developing and Testing

To get started:

yarn
composer install

To build once:

yarn build

To turn on watch mode (useful during development):

yarn watch

JS and Sass linting are handled by Node packages (and thus via Yarn scripts); PHP linting is handled via a Composer package (and thus via Composer scripts):

yarn lint
composer lint

To apply lint fixes automatically (use with caution - make sure your working tree is clean first):

yarn fix
composer fix

Run tests (which may or may not do much yet!):

yarn test
composer test

Deployment

Deployment of this repo to tm.id.au is handled by Travis CI.

After linting and tests pass, the custom .deploy.sh script is run. This performs a number of steps to deploy to the firewalled EC2 instance that my WordPress instance is running on. It triggers static site generation via a custom WP-JSON endpoint for the Simply Static plugin, which then triggers syncing to S3 via an on-server script.

License

GPLv3.