Velocity Project Plugin Baseplate Readme

This Wordpress plugin is responsible for all the backend related elements (functions, methods, classes, setup, config and Gutenberg blocks), as well as providing the default markup and styling for components, blocks and modules. These frontend facing foundation elements provide a starting point, and although they are developed to work out the box, they are ultimately overwritten/manipulated by the theme in order to provide a custom theme based experience.

Table of Contents

1. Getting Started
2. Background - what is VSB?
3. Coding Standards
4. Files / Processing / Gulp
5. Working with Blocks
6. Helpers and Functions
7. Pushing Releases
8. Converting from Bootstrap to Tailwind

Getting Started

Clone this repository into a new folder and run:

- nvm use to use the correct node version
- npm install to install dependencies.
- gulp build to build the plugin.
- symlink the plugin to your current wordpress project using ln -s /[path to your project folder]/www/wp-content/plugins/[plugin folder]/ /[path to this plugin folder]/dist/wp-content/plugins/
- gulp watch to watch for changes and rebuild the plugin.

Be sure to read the coding standards before contributing to the plugin.