tyler-paulson / launchframe

Whiteboard Wordpress Boilerplate.

Launchframe

Features

• Built on top of the powerful and modern Lumberjack MVC Framework.
• Tailwind CSS Framework & Sass for the styling.
• Modern JavaScript using libraries such as GreenSock & ScrollMagic
• Vue.js capabilities ready to go!
• Laravel Mix for compiling assets and concatenating and minifying files
• Twig as a templating engine and integrating with WordPress using Timber.
• ACF for creating an assortment of custom fieldsets.

Setup

• From the project root, run composer install
• Set the document root on your webserver to the web folder: /path/to/site/web/
• Update the .env file
• Login & activate plugins

Theme development

• From the theme directory, run composer install
• npm install to install dependencies
• Update webpack.mix.js with your local dev URL
• You are good to go to activate the theme now inside of WordPress

Build commands

• npm run watch — Compile assets when file changes are made, start Browsersync session
• npm run dev — Compile and optimize the files in your assets directory
• npm run production — Compile assets for production

Partials Structures

The partials for Twig, JS, and Sass all have sub-folders for better organization and abstraction.

• Components - The smallest reusable item, such as a button or post item card.
• Module - This is for a whole layout section that can contain multiple smaller components. For an example: Hero, CTA
• Block - Blocks are the same type of items as the modules, just that these are meant to be Flex Blocks.