Skip to content

kush1960/Wordpress-Workflow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Wordpress Workflow

Skeleton project for Wordpress web development.

Includes Gulp for...

  • SCSS compiling
  • Automatically adding vendor prefixes to CSS
  • Concatinating JS to minimise server requests and allow dev js to be seperated in to multiple files for modularity
  • Linting Javascript errrors
  • Minifying CSS
  • Browser Sync - https://www.browsersync.io/
  • CSS sourcemaps

(Optionally) Includes Bower for...

Installing

Checkout repo into the project root folder

git clone https://github.com/kush1960/Wordpress-Workflow.git <public>

Download the lastest stable Wordpress (https://wordpress.org/latest.zip) and copy over the top of the Workflow files

In Terminal navigate to wp-content/themes/workflow/

Install development dependencies with NPM

npm install

(Note Bower is optional - just remove lines from style.scss and header.php if you don't want to use it)

Install front end dependencies with Bower

bower install

Project notes

  • Modernizr should be custom built on a per project bases, only featuring the tests that the website need to test for. The version supplied includes all tests and should not be used on production sites*.

How to use

Once installed just run npm run watch and you're away.

When working with Javascript follow the simple rules...

  1. Put all plugins in the js/dev/plugins folder.
  2. Put all custom scripts in the js/dev folder.
  3. Prefix your files with numbers if you need to ensure something is loaded before something else.

Gulp will combine all JS in to main.js

Generating minified versions

At the end of a project you may want to minif your CSS/JS. Simply run

npm run minify

This will create js/main.min.js and style.min.css. It will only minify your existing CSS/JS - it will not recompile anything.


README.md template for your live project


{Name of Project}

{Brief paragraph introducing the project and describing it's functionality}

Live URL

http://www.{name of project}.co.uk/

Staging URL

http://{name of project}.devcite.co.uk/

Development URL

http://{name of project}.dev.co.uk/

Local development setup

{Description of how to setup the project for local development}

Project dependencies:

Front-end dependencies:

Required Plugins :

Deployment

This project is configured for auto deployment using DeployHQ. Auto deployment has been setup for the following branches:

Staging site

staging

Live site

production

Further information

{Other information about the project here}

About

Starter Wordpress Theme

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published