Skip to content

verdigado/sunflower

Repository files navigation

sunflower WordPress Theme

This is sunflower, a WordPress-Theme for the german green party. It is based on the starter theme _s.

This repo is for development only, it is not usable out of the box within WordPress. See Installation -> Setup for the required steps to start developing.

Demo and Download

Chat-Channel

There is also a chat-channel (access for green party members only) https://chatbegruenung.de/channel/sunflower-wordpress

Installation

Requirements

sunflower requires the following dependencies:

Setup

  • Clone this repo into wp-content/themes
  • install the Node.js and Composer dependencies in sunflowers theme folder:
    composer install
    npm install
  • compile the theme with the following commands:
    npm run compile:css
    npm run composer-lib
    npm run copy-node-modules
    npm run build
  • activate sunflower in WordPress-Backend

Available CLI commands

  • composer lint:wpcs : checks all PHP files against PHP Coding Standards.
  • composer lint:php : checks all PHP files for syntax errors.
  • composer make-pot : generates a .pot file in the languages/ directory.
  • vendor/bin/rector: run rector with provided rector.php.
  • vendor/bin/ecs: run ecs with provided ecs.php.
  • npm run compile:css : compiles SASS files to css.
  • npm run compile:rtl : generates an RTL stylesheet.
  • npm run watch : watches all SASS files and recompiles them to css when they change.
  • npm run lint:scss : checks all SASS files against CSS Coding Standards.
  • npm run lint:js : checks all JavaScript files against JavaScript Coding Standards.
  • npm run bundle : generates a .zip archive for distribution, excluding development and system files.
  • npm run start : start watcher for js-files
  • npm run build : build javascript

Deployment

see Makefile for tasks

Publishing

see Documentation in mkdocs/docs for more details

Contributing

see Documentation in mkdocs/docs for more details