Giter VIP home page Giter VIP logo

forward-framework's Introduction

forward-wordpress-starter-theme

Forward Framework

A killer WordPress theme framework built using underscores, gulp, sass, bourbon, bourbon neat, bower & browsersync. This project is also available as a pre-compiled WordPress starter theme.

Child Theme Setup

A Child Theme starting point of the Forward Framework is available on the child-theme branch. Make sure to read Setup & Overriding Styles.

Standalone Setup

Keep Reading!

Where Do I Put This?

Clone/Fork/Download this project wherever you like and symlink build/ to wp-content/themes/[example-theme].

Note: Values [inside-brackets] can be changed.

$ git clone [email protected]:drawbackwards/Forward-Framework.git ~/[Sites]/[forward-framework]

$ cd ~/Sites/[example-wordpress-install]/wp-content/themes/

$ ln -s ~/Sites/forward-framework/build [example-theme]

Your themes directory should now look like this:

`- wp-content/
  |- plugins/
  `- themes/
    |- example-theme -> ~/Sites/forward-framework/build
    `- twentyfifteen/

Modify Project Variables

  1. Open gulpfile.js and modify the project and url variables accordingly.
  2. MAMP Users: Enable the port 8888 parameter for BrowserSync (Search for 'Port setting for MAMP users' in gulpfile.js).

Install Gulp Globally

$ npm install --global gulp

Install Gulp Plugins / Dependencies

$ cd ~/Sites/forward-framework/

$ npm install

Install Bower & Components

$ npm install -g bower

$ bower install

Generate Theme Files

This will generate the initial theme files in build/.

$ gulp build

Activate Theme & Create a Navigation Menu

  1. Activate theme at [localhost]/wp-admin/themes.php
  2. Create a new menu at [localhost]/wp-admin/nav-menus.php and assign to the Primary Menu Theme location.

Project Commands

gulp build

Running gulp build will generate/rebuild the build/ directory without starting a watch process.

$ gulp build

gulp

Running gulp or gulp watch will start the watch process & browser-sync. Changes to src/ are written to build/.

$ gulp

gulp dist

Running gulp dist will generate an optimized, production ready version of the theme based on build/. This will be the folder you deploy to production.

$ gulp dist

License

  • Licensed under the GPLv3.

Credits

forward-framework's People

Contributors

benleivian avatar xsynaptic avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.