PHP CSS JavaScript
Latest commit 49dc021 May 26, 2017 @olefredrik committed on GitHub Merge pull request #988 from marcusconnor/kitchen-sink
Kitchen Sink Updated
Permalink
Failed to load latest commit information.
.github Updated Issue Template with New Questions May 19, 2016
assets Sync with Master Breadcrumb May 23, 2017
languages Fix 'Posted on ...' for all languages Oct 16, 2016
library Sync with Master Breadcrumb May 23, 2017
page-templates Merge branch 'master' into kitchen-sink May 23, 2017
template-parts Sync with Master Breadcrumb May 23, 2017
.babelrc Added Babel to JavaScript build pipeline Feb 28, 2016
.bowerrc Updated Sep 7, 2015
.editorconfig Add an .editorconfig file Jul 8, 2016
.gitignore Added Wordpress Coding Standards Sniff to Gulp Dec 14, 2015
.travis.yml Sync with Master Breadcrumb May 23, 2017
404.php Sync with Master Breadcrumb May 23, 2017
CHANGELOG.md Update changelog Mar 17, 2017
MIT-LICENSE.txt Remove executable permissions for files Jul 18, 2016
README.md Removed broken links Apr 15, 2017
archive.php Sync with Master Breadcrumb May 23, 2017
bower.json Update font-awesome to v4.7.0 Mar 31, 2017
codesniffer.ruleset.xml Update codesniffer ruleset Oct 13, 2016
comments.php Sync with Master Breadcrumb May 23, 2017
composer.json Remove executable permissions for files Jul 18, 2016
composer.lock Remove executable permissions for files Jul 18, 2016
footer.php Sync with Master Breadcrumb May 23, 2017
functions.php Fix Travis CI Build Errors Mar 14, 2017
gulpfile.js Remove local server url from gulpfile Jan 11, 2017
header.php Sync with Master Breadcrumb May 23, 2017
index.php Sync with Master Breadcrumb May 23, 2017
package.json update bower version Feb 27, 2017
page.php Sync with Master Breadcrumb May 23, 2017
screenshot.png Remove executable permissions for files Jul 18, 2016
search.php Sync with Master Breadcrumb May 23, 2017
searchform.php Remove executable permissions for files Jul 18, 2016
sidebar.php Remove executable permissions for files Jul 18, 2016
single.php Sync with Master Breadcrumb May 23, 2017
style.css Update version number to 2.9.2 Mar 23, 2017
woocommerce.php Sync with Master Breadcrumb May 23, 2017

README.md

FoundationPress Build Status

Gitter

This is a starter-theme for WordPress based on Foundation 6, the most advanced responsive (mobile-first) framework in the world. The purpose of FoundationPress, is to act as a small and handy toolbox that contains the essentials needed to build any design. FoundationPress is meant to be a starting point, not the final product.

Please fork, copy, modify, delete, share or do whatever you like with this.

All contributions are welcome!

Requirements

This project requires Node.js v4.x.x to v6.9.x to be installed on your machine. Please be aware that you will most likely encounter problems with the installation if you are using v7.1.0 with all the latest features.

FoundationPress uses Sass (CSS with superpowers). In short, Sass is a CSS pre-processor that allows you to write styles more effectively and tidy.

The Sass is compiled using libsass, which requires the GCC to be installed on your machine. Windows users can install it through MinGW, and Mac users can install it through the Xcode Command-line Tools.

If you have not worked with a Sass-based workflow before, I would recommend reading FoundationPress for beginners, a short blog post that explains what you need to know.

Quickstart

1. Clone the repository and install with npm

$ cd my-wordpress-folder/wp-content/themes/
$ git clone https://github.com/olefredrik/FoundationPress.git
$ cd FoundationPress
$ npm install

2. While you're working on your project, run:

$ npm run watch

If you want to take advantage of browser-sync (automatic browser refresh when a file is saved), simply open your Gulpfile.js and put your local dev-server address (e.g localhost) in this field var URL = ''; , save the Gulpfile and run

$ npm run watch

3. For building all the assets, run:

$ npm run build

Build all assets minified and without sourcemaps:

$ npm run production

4. To create a .zip file of your theme, run:

$ npm run package

Running this command will build and minify the theme's assets and place a .zip archive of the theme in the packaged directory. This excludes the developer files/directories from your theme like node_modules, assets/components, etc. to keep the theme lightweight for transferring the theme to a staging or production server.

Styles

  • style.css: Do not worry about this file. (For some reason) it's required by WordPress. All styling are handled in the Sass files described below

  • assets/scss/foundation.scss: Make imports for all your styles here

  • assets/scss/global/*.scss: Global settings

  • assets/scss/components/*.scss: Buttons etc.

  • assets/scss/modules/*.scss: Topbar, footer etc.

  • assets/scss/templates/*.scss: Page template spesific styling

Please note that you must run npm run build or npm run watch in your terminal for the styles to be copied and concatenated. See the Gulpfile.js for details

Scripts

  • assets/javascript/custom: This is the folder where you put all your custom scripts. Every .js file you put in this directory will be minified and concatenated one single .js file. (This is good for site speed and performance)

Please note that you must run npm run build or npm run watch in your terminal for the scripts to be copied and concatenated. See Gulpfile.js for details

The main styles and scripts generated by the build

Version control on these files are turned off because they are automatically generated as part of the build process.

  • assets/stylesheets/foundation.css: All Sass files are minified and compiled to this file

  • assets/stylesheets/foundation.css.map: CSS source maps

  • assets/javascript/vendor: Vendor scripts are copied from assets/components/ to this directory. We use this path for enqueing the vendor scripts in WordPress.

Check For WordPress Coding Standards

Foundation comes with everything you need to run tests that will check your theme for WordPress Coding Standards. To enable this feature you'll need to install PHP Codesniffer, along with the WordPress Coding Standards set of "Sniffs". You'll need to have Composer To install both run the following:

$ composer create-project wp-coding-standards/wpcs:dev-master --no-dev

When prompted to remove existing VCS, answer Yes by typing Y.

Once you have installed the packages, you can check your entire theme by running:

$ npm run phpcs

If there are errors that Code Sniffer can fix automatically, run the following command to fix them:

$ npm run phpcbf

Demo

Unit Testing With Travis-CI

FoundationPress is completely ready to be deployed to and tested by Travis-CI for WordPress Coding Standards and best practices. All you need to do to activate the test is sign up and follow the instructions to point Travis-CI towards your repo. Just don't forget to update the status badge to point to your repositories unit test. Travis-CI

UI toolkits for rapid prototyping

Tutorials

Documentation

Showcase

Credit goes to all the brilliant designers and developers out there. Have you made a site that should be on this list? Please let me know

Contributing

Here are ways to get involved:

  1. Star the project!
  2. Answer questions that come through GitHub issues
  3. Report a bug that you find
  4. Share a theme you've built on top of FoundationPress
  5. Tweet and blog your experience of FoundationPress.

Pull Requests

Pull requests are highly appreciated. Please follow these guidelines:

  1. Solve a problem. Features are great, but even better is cleaning-up and fixing issues in the code that you discover
  2. Make sure that your code is bug-free and does not introduce new bugs
  3. Create a pull request
  4. Verify that all the Travis-CI build checks have passed