FoundationPress

This is a starter-theme for WordPress based on Foundation for Sites 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!

Huge thanks to olefredrik (and all contributors) to create the base this starter theme is forked from.

Requirements

This project requires Node.js v10.x.x to be installed on your machine. Please be aware that you might encounter problems with the installation if you are using the most current Node version (bleeding edge) 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. FoundationPress uses the SCSS syntax from Sass. The Sass is compiled using the JavaScript Library of Dart Sass and does not require any external dependencies.

Quickstart

1. Clone the repository and install with npm

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

2. Configuration

Livereload

If you want to take advantage of automatic browser refresh when a file is saved, simply run the grunt watch task grunt watch after installing it in the previous steps. You just need to install e.g. the livereload extension for your browser or include the livereload script manually in your website. More infos can be found here.

3. Get started

$ npm run start # production compilation with watch task at the end
$ npm run dev # development compilation with watch task at the end (faster, but no optimized assets).
$ npm run autofix # autofixes some code (formatting) errors
$ npm run update # updates all npm dependencies to their latest version

4. Compile assets for production

When building for production, the CSS and JS will be minified & optimized. To run a production build, run:

$ npm run build

To create a .zip file of your theme, run: (TODO: implement with Grunt again. Currently not available.)

$ 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, /src, etc. to keep the theme lightweight for transferring the theme to a staging or production server.

Project structure

Inside of the /src folder you will find the working files for all your assets. Every time you make a change to a file that is watched by Grunt, the output will be saved to the /dist folder. The contents of the /dist folder is the generated code that you should not touch (unless you have a good reason for it).

The /page-templates folder contains templates that can be selected in the Pages section of the WordPress admin panel. To create a new page-template, simply create a new file in this folder and make sure to give it a template name.

Styles and Sass Compilation

• style.css: Required by WordPress to make this theme work properly. All CSS inside this file won't be enqueued.

All styling are handled in the Sass files described below:

• src/assets/scss/components/*.scss: Components like Buttons, Searchbars, Tabs, Accordions, etc. Components are reuseable elements, so design them in a way they can be used independently and in combination with other elements without affecting their appearance.
• src/assets/scss/global/*.scss: Global styles. Define helper classes or element styles here (like a, p, h1, h2, h3, ... ).
• src/assets/scss/mixins/*.scss: Put all your custom SCSS mixins here.
• src/assets/scss/modules/*.scss: Topbar, footer etc. This are more or less sections or combinations of different components and elements.
• src/assets/scss/templates/*.scss: Page template styling. Styles for individual pages especially the ones in /page-templates.
• src/assets/scss/pages/*.scss: Places styles for single pages here. Make sure to use a identifier like .page-id-{ID}, .home, etc. Note: in gerneral it's not recommended. Better use a modifier class for the elements you want to change.
• src/assets/scss/_foundation.scss: All Foundation inclues. Uncomment unused styles to reduce filessize.
• src/assets/scss/_settings.scss: All Foundation component styles can be configured here. Also add custom SCSS variables like colors here in the global section.
• src/assets/scss/admin.scss: Entrypoint for admin styles. These are loaded in the WordPress backend.
• src/assets/scss/editor.scss: Entrypoint for editor styles. These are included for the Gutenberg editor.
• src/assets/scss/main.scss: Entrypoint for main styles which are loaded in the front-end.

If you're new to Sass, please note that you need to have Grunt running in the background (npm run start), for any changes in your SCSS files to be compiled to main.css in the /dist/assets/css folder.

JavaScript Compilation

All JavaScript files, including Foundation's modules, are imported through the src/assets/js/app.js file. The files are imported using module dependency with webpack as the module bundler.

If you're unfamiliar with modules and module bundling, check out this resource to understand ES6 modules.

Foundation modules are loaded in the src/assets/js/lib/foundation.js file. By default all components are loaded. You can also pick and choose which modules to include to decrease the JavaScript file size. Just comment out the modules you don't need and follow the instructions in the file.

If you need to output additional JavaScript files separate from app.js, do the following:

• Create new custom.js file in src/assets/js/. jQuery is automatically included if you use either jQuery or $ variables in your code.
• In tasks/options/webpack.js, add the new file as an entry analogous to the app.js file.
• Build (npm run start)
• You will now have a custom.js file outputted to the dist/assets/js/ directory. Remember to enqueue it in /inc/enqueue-scripts.php.

Translations

To update the languages/FoundationPress.pot file for translations install the WP-CLI and run npm run make-pot.

To update the .mo & .po files for the different languages have a look at Loco Translate.

Automated Deployment with GitHub Actions

To see all workflows have a look at the /.github/workflows/ folder.

Secrets / Environment Variables

• FONTAWESOME_NPM_AUTH_TOKEN Optionally, the FontAwesome Pro NPM Auth token. Get it in your account.
• STAGING_DEPLOY_KEY and PROD_DEPLOY_KEY SSH key for destination server
• STAGING_SSH_USER_HOST and PROD_SSH_USER_HOST e.g. [email protected]
• STAGING_SSH_DEST_PATH and PROD_SSH_DEST_PATH e.g. ~/example.com/wp-content/themes/FoundationPress
• STAGING_SSH_WP_ROOT and PROD_SSH_WP_ROOT Root directory where the WordPress files are located and WP CLI will be executed. e.g. ~/example.com

Deploying to staging server

1. Set all the STAGING_secrets mentioned above
2. merge/push to branch master (manually or by pull request).

You might want to customize the workflow job stagingServerSetup where you can specify what WP CLI commands should run afterwards.

If deployed to staging server, we'll automatically:

• install & activate disable-emails
• install & activate log-emails
• deactivate wp-mail-smtp to prevent sending of emails to customers and store them in the database instead.

If one of the following maintenance plugins are installed they are automatically activated, so that the staging site won't be accessible by the public:

• WP Maintenance Mode by Designmodo
• Coming Soon Page, Maintenance Mode & Landing Pages by SeedProd Note: this plugin is only activated. If the maintenance setting is disabled it still won't show the maintenance page.

Deploying to production server

1. set all the PROD_secrets mentioned above
2. create a production branch
3. merge/push to it (manually or by pull request).

You might want to customize the workflow job productionServerSetup where you can specify what WP CLI commands should run afterwards.

FontAwesome Pro

If you're using FontAwesome Pro add the FONTAWESOME_NPM_AUTH_TOKEN secret to your repository.

Local Development

We recommend using one of the following setups for local WordPress development:

• Local (macOS, Windows, Linux)
• VVV (Varying Vagrant Vagrants) (Vagrant Box)
• MAMP (macOS)
• WAMP (Windows)
• LAMP (Linux)
• Trellis

Documentations

• Foundation Docs
• WordPress Codex

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

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 build checks have passed