Skip to content

jcklpe/common-wp-theme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Common WP

This is a wordpress theme for non-profit use. It's focus is on simple visual design, and clean componentized code for easy customization by organizations with diverse needs.

Requirements

In order to use this theme fully you need to install the [Common WP Blocks] plugin and the [The Events Calendar]. In order to make edits to the theme you need to have a basic familiarity with cli, npm, and gulp,

Build Process

This theme uses a gulp build system.

To build the theme you just need to install the package manager npm and run npm install in the theme root folder then run gulp to build a new version of the build files.

You can also use the command gulp dev to watch the src folder for any changes to the files as you work so that it can seamlessly build new versions of the build files in the background. Browsersync is included so when you first dev it will open up a proxy server in your default browser which will reload the page every time there is a new build.

TODO:

  • componentize out scss parts and reorganize build process
  • replace all hardcoded logos with global custom fields
  • replace all hardcoded text with global custom fields
  • convert all custom template blocks into template partials
  • white label all organizational references
  • break out block components into a separate companion plugin
  • complete blocks companion plugin.
  • re-align php templates in light of more flexible blocks based page building project.
  • Build theme scss to "overlay" the default styling of the block companion plugin to make this easier for people to customize for other contexts
  • convert build process to gulp 4
  • Lots of other stuff

License

licensed under Cooperative Work License v 1.0