vweltje / os-base-kit

Base kit for Wordpress custom theme development

OS Base Theme

Wordpress default theme & components for Oddessey Solutions.

Dependencies

• Laravel-mix: for compiling assets (js & scss)
• Ftp: for uploading files to remote
• Fs: to monitor file changes
• Node
• npm

Development

npm run watch

This will start webpack which will compiles our assets and uploads changed files to the remote server (if required). Changes code in sources/, all files will be compiled automatically and copy to the root directory of the theme.

If running for the first time. there is a one time setup to run through:

Setting up local environment

You will need to have a local server with database running. I recommend using Laravels Valet, but basically anything allowing you to run php and have a mysql database will do the trick! Just make sure your PHP version is at least 7.1 or higher.

Installation:

• Clone or download the repo into your theme folder
• Open terminal and cd to this directory
• Run the install: npm install
• (optional) set your ftp details in webpack.mix.js
• When it has finished, run npm run watch
• Start coding

Plugins

Advanced Custom Fields Pro (ACF)

For custom fields on pages and post types Advanced Custom Fields Pro is used. Add your copy of ACF pro to the plugin folder.

Custom Post Type UI

To provide our site with custom post types and taxonomies the plugin Custom Post Type UI is used. You can install this plugin inside the plugin tab on the admin page.

Inspired by

• wp-flex-kit
• flex-with-benefits