1.2.6 ā€¢ Published 3 years ago

bootflow-cli v1.2.6

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

WordPress Scaffolding Theme Generator

BOOTFLOW-CLI : A WordPress Developer Toolkit

A WordPress developer toolkit that kickstarts your next WordPress theme development project with modern tools and workflows.

Version: v1.1.0 License npm Maintainer

šŸš€ How it works?

Bootflow-cli scaffolds a starter WordPress theme inside your wp-content/themes folder using the values supplied through a CLI interface. The starter theme supports Gulp, SASS, Babel, Webpack, AutoPrefixer, BrowserSync (Reloads your browser while development), assets minification and image optimizations.

You can just start using modern development tools and plugins in your WordPress theme Development Stack with almost no-configuration involved.

āš”ļø Quick Installation

Ā  Ā  Ā  Ā  ā–¶ļø Create a Fresh Bootflow Theme

Ā  Ā  Ā  Ā  ā–¶ļø Integrate Bootflow In An Existing Theme

āš”ļø Create a Fresh Theme

Go your terminal and cd to your local wp-content directory, where you want to start developing the theme and run the below given npx command:

npx bootflow-cli

You will be asked a few questions to generate your theme files, answer them correctly and a fresh copy of your development scaffolding theme will be generated inside your themes folder.

Bootflow-cli installation

The Generated WordPress Theme

Generated Developer WordPress theme supports:

  • Bootstrap 5.x, FontAwesome 5.x
  • SASS Compilation
  • CSS AutoPrefixer
  • JS Babel Transpilation (ES6 Presets)
  • Webpack 5 Script Bundling
  • Assets Minification (CSS, JS, Images)
  • Image Optimizer (JPEG, GIF, PNG and SVGs)
  • CSS Sprite Images
  • BrowserSync for a no-lag browser reload on file changes
  • Gulp Workflow

Generated Theme's Folder Structure

.
ā””ā”€ā”€ themes
    ā””ā”€ā”€ bootflow
        ā”œā”€ā”€ assets                (hold the compiled CSS,JS,Images)
        ā”‚Ā Ā  ā”œā”€ā”€ css
        ā”‚Ā Ā  ā”œā”€ā”€ images
        ā”‚Ā Ā  ā”œā”€ā”€ js
        ā”‚Ā Ā  ā””ā”€ā”€ webfonts
        ā”œā”€ā”€ assets_src            ( Static Assets Source Files )
        ā”‚Ā Ā  ā”œā”€ā”€ images
        ā”‚Ā Ā  ā”œā”€ā”€ js                ( Webpack or Babel JS )
        ā”‚Ā Ā  ā”œā”€ā”€ scss              ( All Your SCSS Files )
        ā”‚Ā Ā  ā”œā”€ā”€ sprite_images     ( Your Sprite Icons/Images )
        ā”‚Ā Ā  ā””ā”€ā”€ webfonts
        ā”œā”€ā”€ babel.config.json
        ā”œā”€ā”€ footer.php
        ā”œā”€ā”€ functions.php
        ā”œā”€ā”€ gulpfile.js           ( Gulp Config and tasks folder )
        ā”œā”€ā”€ header.php
        ā”œā”€ā”€ inc
        ā”‚Ā Ā  ā”œā”€ā”€ classes
        ā”‚Ā Ā  ā”‚Ā Ā  ā”œā”€ā”€ autoload.php           ( PHP Classes autoloader )
        ā”‚Ā Ā  ā”‚Ā Ā  ā”œā”€ā”€ template-functions.php
        ā”‚Ā Ā  ā”‚Ā Ā  ā”œā”€ā”€ theme-hooks.php        ( All your theme hooks )
        ā”‚Ā Ā  ā”‚Ā Ā  ā””ā”€ā”€ theme-setup.php
        ā”‚Ā Ā  ā”œā”€ā”€ helper-functions.php
        ā”‚Ā Ā  ā””ā”€ā”€ loader.php                 ( Loads Classes and helpders )
        ā”œā”€ā”€ index.php
        ā”œā”€ā”€ package.json
        ā”œā”€ā”€ screenshot.png
        ā””ā”€ā”€ style.css

āš”ļø Integrate Bootflow In An Existing Theme

Start using SCSS, WebPack, Gulp, NPM workflow in your exisiting WordPress theme.

Go to the terminal and cd to the WordPress theme directory in which you want to integrate Bootflow and run the below given npx command:

npx bootflow-cli

Complete the questions asked to integrate the workflow and you are done.

šŸ“– Generated Theme's Documentation : Bootflow Theme Github Repo.