Skip to content

rareview/wp-vip-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rareview Starter Theme

Rareview Starter Theme Banner

Modern WordPress starter theme for fast, scalable builds.

  • Based on the 10up Scaffold
  • Follows WP VIP coding standards and best practices
  • Supports WP VIP and WPE platforms
  • Supports fast global styles setup
    • 130+ variables covering global styles
    • One-command Figma global styles sync (beta)
    • Gutenberg compatibility out of the box
    • Fluid responsiveness out of the box
    • Consistent appearance between frontend and block editor
  • Uses the latest PHP without fancy templating languages
  • Built with SEO and accessibility in mind
  • Translation-ready
  • And much more!

Requirements

Clone a Repo

  • Create a new repository by using this repo as a template
  • Clone a newly created repo to your local machine


Initial Setup

After cloning your new repo locally, run the interactive setup script:

npm run setup

This handles all renaming, rebranding, and configuration automatically:

  • Renames the theme directory, translation files, and all references
  • Performs case-sensitive find-and-replace across all project files
  • Updates Lando config, deploy scripts, and CI workflows
  • Generates a project-specific AGENTS.md for AI-assisted development
  • Optionally runs npm install and lando start

For CI or non-interactive use: npm run setup -- --yes To preview changes: npm run setup -- --dry-run


Global Styles Setup

This starter theme relies on theme.json variables and SCSS variables and mixins to set up global styles. Run the design-system CLI command to choose how you want to configure them:

npm run design-system

You will see three options:

  1. Set variables in the terminal: Interactive prompts walk through variables setup.
  2. Set variables manually: Opens the variable mapping guide at docs/variable-mapping.md.
  3. Figma auto sync (beta): Simply paste a Figma design URL and hit Enter. Extraction quality depends on the Figma design's consistency and structure.

Setting up these variables will make most of the global elements such as headings, buttons, color palette etc. work out of the box, fluid responsive, Gutenberg compatible, looking same in frontend and editor, and easy to maintain and scale because everything comes from a single source of truth - variables and mixins.


Local Environment Setup

See Local Development Setup for details.

Theme Development

See Theme Development for details.

License

This repository includes mixed-licensed components:

  • WordPress core/upstream components: GPL (see license.txt)
  • Custom RV project code (scripts, tooling, and theme code): MIT (see LICENSE.md and wp-content/themes/rv-starter/LICENSE.md)

About

WP VIP starter environment, which uses rareview/wp-vip-starter repository as a source for the RV Starter theme updates. Please see README.md

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors