Hero - free wordpress theme
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
languages
library
parts
templates
.bowerrc
.gitignore
.travis.yml
404.php
CHANGELOG.md
Gruntfile.js
LICENSE
MIT-LICENSE.txt
README.md
archive.php
bower.json
codesniffer.ruleset.xml
comments.php
composer.json
composer.lock
content-none.php
content-video.php
content.php
footer.php
functions.php
header.php
index.php
package.json
page.php
screenshot.png
search.php
searchform.php
sidebar-left.php
sidebar.php
single.php
style.css
woocommerce.php

README.md

FoundationPress Build Status

This is a WordPress starter theme based on Foundation 5 by Zurb. 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. If you're looking for an all-in-one theme with built-in shortcodes, plugins, fancypancy portfolio templates or whatnot, I'm afraid you have to look elsewhere.

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

All contributions are welcome!

Requirements

Please read this. It's totally worth it.

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

All the Sass (.scss) files are compiled into one single css file. To make this happen, we use a tool called Grunt; a task runner that automates repetitive tasks like minification, compilation, linting, etc.

NOTE: You'll need to have Node.js installed before continuing.

Quickstart

1. Clone the repository and install dependencies with npm

$ cd my-wordpress-folder/wp-content/themes/
$ git clone git@github.com:olefredrik/FoundationPress.git
$ mv FoundationPress your-theme-name
$ cd your-theme-name

$ npm install
# bower install && grunt build will be called via npm scripts when you run npm install.

(Many project force their users to install Bower and Grunt globally. We don't like that and decided to use them via npm scripts which means, that Grunt and Bower are installed in your node_modules folder and we'll call them there.)

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

$ npm run watch

3. For building all the assets, run:

$ npm run build

4. Compress all files required for deployment:

It is not recommended that you deploy the entire theme folder to your webserver. There is no danger associated with doing this, but it is a waste of disk space and bandwidth. The node_modules and components for instance is only required during theme development.

By executing the command below, you will compress only the files that are required for deployment. The file will be available as a .zip inside the folder named '/package'.

$ npm run package

How to structure your 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: Imports for Foundation components and your custom styles.

  • assets/scss/config/_settings.scss: Original Foundation 5 base settings

  • assets/scss/config/_custom-settings.scss: Copy the settings you will modify to this file. Make it your own

  • assets/scss/site/*.scss: Unleash your creativity. Create the files you need (and remember to make import statements for all your files in assets/scss/foundation.scss)

Please note that you must run $npm run build in your terminal for the styles to be copied and concatinated. See Gruntfile.js for details

How to structure your 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 concatinated one single .js file. (This is good for site speed and performance)

Please note that you must run npm run build in your terminal for the scripts to be copied and concatinated. See Gruntfile.js for details

The 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/javascript/components/ to this directory. We use this path for enqueing the vendor scripts in WordPress.

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

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. More than three dozen amazing people have contributed to FoundationPress (so far). Here are some guidelines to help:

  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

Documentation

hero

Hero - free wordpress theme