Sage - Wordpress starter theme

Sage using Vue CLI

Requirements

• Vue CLI >= 4.0.0
• Node.js >= 10.0.0
• Yarn

Theme installation

Install Sage using Composer from your WordPress themes directory (replace your-theme-name below with the name of your theme):

# @ app/themes/ or wp-content/themes/
$ composer create-project ravorona/sage your-theme-name

To install the latest development version of Sage, add dev-master to the end of the command:

$ composer create-project ravorona/sage your-theme-name dev-master

Theme structure

themes/your-theme-name/   # → Root of your Sage based theme
├── app/                  # → Theme PHP
│   ├── Controllers/      # → Controller files
│   ├── admin.php         # → Theme customizer setup
│   ├── filters.php       # → Theme filters
│   ├── helpers.php       # → Helper functions
│   └── setup.php         # → Theme setup
├── composer.json         # → Autoloading for `app/` files
├── composer.lock         # → Composer lock file (never edit)
├── dist/                 # → Built theme assets (never edit)
├── node_modules/         # → Node.js packages (never edit)
├── public/               # → Static assets folder. Every assets placed in this folder will be copied through webpack (never edit)
├── package.json          # → Node.js dependencies and scripts
├── resources/            # → Theme assets and templates
│   ├── assets/           # → Front-end assets
│   │   ├── config.json   # → Settings for compiled assets
│   │   ├── config.json   # → Settings for pwa
│   │   ├── fonts/        # → Theme fonts
│   │   ├── images/       # → Theme images
│   │   ├── scripts/      # → Theme JS
│   │   └── styles/       # → Theme stylesheets
│   ├── functions.php     # → Composer autoloader, theme includes
│   ├── index.php         # → Never manually edit
│   ├── screenshot.png    # → Theme screenshot for WP admin
│   ├── style.css         # → Theme meta information
│   └── views/            # → Theme templates
│       ├── layouts/      # → Base templates
│       └── partials/     # → Partial templates
└── vendor/               # → Composer packages (never edit)

Theme development

• Run yarn from the theme directory to install dependencies
• Update common configuration in resources/assets/config.json
• Update vue.config.js for fine tuning

Enable HTTPS on hot reload mode

Define your certificates paths by setting https.key and https.cert in resources/assets/config.json

{
  "https": {
      "key": "path_to_key",
      "cert": "path_to_cert"
  }
}

Build commands

• yarn hot — Compile assets when file changes are made with hot reload
• yarn watch — Compile assets when file changes are made
• yarn build — Compile and optimize the files in your assets directory
• yarn build:production — Compile assets for production

Documentation

• Sage documentation
• Controller documentation
• Vue CLI