Skip to content
This repository was archived by the owner on Dec 14, 2023. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Dockerfile
docker-compose.yml
.git
.gitignore
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
19 changes: 0 additions & 19 deletions .travis.yml

This file was deleted.

10 changes: 10 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
FROM wordpress:php7.1-fpm-alpine
LABEL Maintainer="butlerx <cian@coderdojo.com>"
RUN apk --update --no-cache add curl && \
rm /var/cache/apk/* && \
curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin --filename=composer
COPY [".", "/usr/src/wordpress/wp-content/themes/cd-theme"]
WORKDIR /usr/src/wordpress/wp-content/themes/cd-theme
RUN composer install && \
chown -R www-data:www-data /usr/src/wordpress/wp-content/plugins/ /usr/src/wordpress/wp-content/themes/
WORKDIR /var/www/html
56 changes: 33 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,48 @@
# CD-theme

## !! Changes made to this Theme
See [docs/riot.md](/docs/riot.md) for specific instructions around customisations in this Theme

# The Timber Starter Theme

The "_s" for Timber: a dead-simple theme that you can build from. The primary purpose of this theme is to provide a file structure rather than a framework for markup or styles. Configure your Sass, scripts, and task runners however you would like!

[![Build Status](https://travis-ci.org/timber/starter-theme.svg)](https://travis-ci.org/timber/starter-theme)
See [docs/riot.md](/docs/riot.md) for specific instructions around
customisations in this Theme

## Installing the Theme

Install this theme as you would any other, and be sure the Timber plugin is activated. But hey, let's break it down into some bullets:
1. Download the zip for this theme (or clone it) and move it to `wp-content/themes`
in your WordPress installation.
1. Run `composer install` to set up the theme and plugins
1. Activate the theme in Appearance > Themes.
1. Activate all the plugins
1. Do your thing! And read [the docs](https://github.com/jarednova/timber/wiki).

1. Make sure you have installed the plugin for the [Timber Library](https://wordpress.org/plugins/timber-library/) (and Advanced Custom Fields - they [play quite nicely](https://github.com/jarednova/timber/wiki/ACF-Cookbook) together).
2. Download the zip for this theme (or clone it) and move it to `wp-content/themes` in your WordPress installation.
3. Rename the folder to something that makes sense for your website (generally no spaces and all lowercase). You could keep the name `timber-starter-theme` but the point of a starter theme is to make it your own!
4. Activate the theme in Appearance > Themes.
5. Do your thing! And read [the docs](https://github.com/jarednova/timber/wiki).
## What's here

## What's here?
`static/` is where you can keep your static front-end scripts, styles, or images.
In other words, your Sass files, JS files, fonts, and SVGs would live here.

`static/` is where you can keep your static front-end scripts, styles, or images. In other words, your Sass files, JS files, fonts, and SVGs would live here.
`templates/` contains all of your Twig templates. These pretty much correspond 1
to 1 with the PHP files that respond to the WordPress template hierarchy. At the
end of each PHP template, you'll notice a `Timber::render()` function whose first
parameter is the Twig file where that data (or `$context`) will be used.
Just an FYI.

`templates/` contains all of your Twig templates. These pretty much correspond 1 to 1 with the PHP files that respond to the WordPress template hierarchy. At the end of each PHP template, you'll notice a `Timber::render()` function whose first parameter is the Twig file where that data (or `$context`) will be used. Just an FYI.
`bin/` and `tests/` ... basically don't worry about (or remove) these unless you
know what they are and want to.

`bin/` and `tests/` ... basically don't worry about (or remove) these unless you know what they are and want to.
## Development

Development is done with docker. To start the wordpress run
`docker-compose up -d` and open `localhost:8008`

## Other Resources

The [main Timber Wiki](https://github.com/jarednova/timber/wiki) is super great, so reference those often. Also, check out these articles and projects for more info:
The [main Timber Wiki](https://github.com/jarednova/timber/wiki) is super great,
so reference those often. Also, check out these articles and projects for more info:

* [This branch](https://github.com/laras126/timber-starter-theme/tree/tackle-box) of the starter theme has some more example code with ACF and a slightly different set up.
* [This branch](https://github.com/laras126/timber-starter-theme/tree/tackle-box)
of the starter theme has some more example code with ACF and a slightly
different set up.
* [Twig for Timber Cheatsheet](http://notlaura.com/the-twig-for-timber-cheatsheet/)
* [Timber and Twig Reignited My Love for WordPress](https://css-tricks.com/timber-and-twig-reignited-my-love-for-wordpress/) on CSS-Tricks
* [Timber and Twig Reignited My Love for WordPress](https://css-tricks.com/timber-and-twig-reignited-my-love-for-wordpress/)
on CSS-Tricks
* [A real live Timber theme](https://github.com/laras126/yuling-theme).
* [Timber Video Tutorials](https://github.com/jarednova/timber/wiki/Video-Tutorials) and [an incomplete set of screencasts](https://www.youtube.com/playlist?list=PLuIlodXmVQ6pkqWyR6mtQ5gQZ6BrnuFx-) for building a Timber theme from scratch.

* [Timber Video Tutorials](https://github.com/jarednova/timber/wiki/Video-Tutorials)
and [an incomplete set of screencasts](https://www.youtube.com/playlist?list=PLuIlodXmVQ6pkqWyR6mtQ5gQZ6BrnuFx-)
for building a Timber theme from scratch.
43 changes: 27 additions & 16 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "upstatement/timber-starter-theme",
"description": "Starter theme to build a Timber theme",
"type":"wordpress-theme",
"minimum-stability" : "stable",
"name": "cd-theme",
"description": "CoderDojo theme for wordpress",
"type": "wordpress-theme",
"minimum-stability": "stable",
"authors": [
{
"name": "jarednova",
"email": "jared@upstatement.com"
}
{
"name": "CoderDojo Foundation",
"email": "info@coderdojo.org"
}
],
"repositories": [
{
Expand All @@ -16,14 +16,25 @@
}
],
"extra": {
"installer-paths": {
"../../plugins/{$name}/": [
"wpackagist-plugin/*",
"type:wordpress-plugin"
]
}
},
"installer-paths": {
"./plugins/{$name}/": ["wpackagist-plugin/*", "type:wordpress-plugin"]
}
},
"require": {
"wpackagist-plugin/timber-library": "0.22.*"
"wpackagist-plugin/amazon-s3-and-cloudfront": "1.2",
"wpackagist-plugin/antispam-bee": "2.7.1",
"wpackagist-plugin/caldera-forms": "1.5.6.2",
"wpackagist-plugin/cloudflare": "3.3.1",
"wpackagist-plugin/custom-share-buttons-with-floating-sidebar": "3.3",
"wpackagist-plugin/google-captcha": "1.32",
"wpackagist-plugin/optimizely": "3.7.8",
"wpackagist-plugin/pods": "2.6.11",
"wpackagist-plugin/redirection": "2.8",
"wpackagist-plugin/sucuri-scanner": "1.8.11",
"wpackagist-plugin/tablepress": "1.8.1",
"wpackagist-plugin/timber-library": "1.5.2",
"wpackagist-plugin/wonderm00ns-simple-facebook-open-graph-tags": "2.1.3",
"wpackagist-plugin/wordpress-importer": "0.6.3",
"wpackagist-plugin/wp-mail-smtp": "0.10.1"
}
}
Loading