FoundationPress

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

This project requires NodeJS to be installed on your machine. Works with 0.10, 0.12, and 4.1! Note that parts of our build process will break with NPM 3, due to the changes in how packages are installed.

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

(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. Bower install and grunt build will be called via npm scripts when you run npm install.)

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 '/packaged'.

$ 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:

Star the project!
Answer questions that come through GitHub issues
Report a bug that you find
Share a theme you've built on top of FoundationPress
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:

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

yshahin / fa3elkheir-theme Goto Github PK

fa3elkheir-theme's Introduction