Home

Awesome

image

Tweet Twitter Follow

VueWordPress Theme Starter

A true WordPress theme with the guts ripped out and replaced with Vue. Looking to create a Vue-powered WordPress plugin? I've got a starter for that too!

Who's this for? When I started diving into using Vue in WordPress I found plenty of great starters for headless WordPress, but I had the added constraint of needing to run the front and backend on the same host, thus this project was created.

Need help? Join the VueWordPress Slack.

Features

Getting started

Watch the getting started video

  1. Clone the repo inside of your wp-content/themes/ directory
  2. Navigate to the theme directory in your terminal and run npm install npm run watch for development npm run build when you're ready to deploy the theme.
  3. Activate the theme in your WordPress instance.
  4. Update your permalink settings (Settings -> Permalinks) to be "Day and name". If you don't want to use this setting you'll need to update the Vue router so it can find your content correctly. Please note that if you want to use a different permalink structure you'll need to update ./src/router/index.js so it looks for the correct path.
  5. Boom.com!

Since by default Tailwind completely resets all styles/spacing, there are a few initial styles I've provided in src/assets/css/_tailwind.css to make things appear more like you'd expect. Modify to your liking!

Video Training

Code Organization

All of the code you're going to edit is located in /src/. From there it's broken into a few logical directories.

All scripts and styles in /src are compiled down to the /dist directory, which is what you will deploy. When you're ready to deploy don't deploy the src/ directory.

New to Vue?

Not sure where to begin? The Vuejs documentation is actually amazing, but if you're looking for video training I highly recommend the free Learn Vue 2: Step By Step course over at Laracasts. There's also a great playlist by Academind available on YouTube that covers pretty much everything you'd want to know about building a fully-featured Vue app.

I've created a couple of example components in src/components/widgets to give you an idea of how to work with the Vuex store data.

If you're new to Vue/Vuex I would do the following:

The first thing you're probably going to want to do is start editing and components in src/components/.

External References

Features coming soon:

Changelog

2020-01-29


2020-01-28


2020-01-28


2019-02-05 Added

Changed

Removed


2018-08-20 Added

Removed


2017-10-24 Added

2017-10-21 Removed

Changed

Fixed


2017-10-17 Added

Changed


2017-10-11 Initial commit