Skip to content

digitalsurgeons/boilerplate-wordpress

Repository files navigation

DS Boilerplate

Quick start

npm install

Pass your local site url to a bash variable

site=[site url here] npm run dev

Default login to the WP dashboard:
admin : boilerplate

We don't need to tell you to change this but, change this as soon as possible.

Build Process

Currently the boilerplate uses Webpack 3.x. JS is auto-globbed and does not require manual additions to a app.js file. However, the SCSS is more complicated and doesn't make globbing easy. We hope to change this in the future. Any new JS files require a restart of Webpack's watcher.

Twig

The new Boilerplate uses Twig as a templating engine through the awesome Timber plugin for Wordpress. Currently, each view extends the _layout.twig file and contains a content block. An example of how to use this is in the _page.twig template. Routing is handled by if statements currently (better solutions very welcomed). Check out index.php for a rudimentary intro into simple routing. More resources for Timber/Twig can be found here:

Advanced Custom Fields

We use ACF extensively on our builds. We have a single Components group that houses our component library.

๐Ÿ†• ACF JSON

We recently started using ACF JSON which, upon save of a field will save a copy of your group in a JSON file in the boilerplate theme directory. These should be tracked in git. For more information on how this work check out the ACF Docs and information on syncing.

Front End Style

Check out our front-end guide

About

A boilerplate for Wordpress builds

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published