withfatpanda/ship

a WordPress Starter Theme

Ship: a WordPress Starter Theme

Ship is a WordPress Starter Theme standing on the shoulders of giants like Underscores, UnderStrap, and Sage., _(*1)

We called it "Ship" because it helps us ship great web experiences, faster. That speed is achieved through some highly opinionated decisions about tools and process; if you want variety, fork Ship to create your own, or use Sage., _(*2)

Why you should "Ship" your next WordPress Theme:

• It's completely free (as in beer: GPL-2.0)
• Sass stylesheets based on Bootstrap 4
• Mobile-first, responsive design
• Uses NPM to manage dependencies (bye Bower!)
• Build script included, based on Laravel Mix (Webpack in a beautiful disguise)
• Auto-minify, concatenate, and version CSS and JS
• Traditional PHP templates or go DRY with Laravel Blade (requires PHP 7)
• Jetpack ready
• WooCommerce support
• Contact Form 7 support
• Translation ready

Other features, in progress:

• Algolia ready: real-time search for admins and visitors
• Vue.js for building themes as Single-Page Applications
• A theme builder framework based on Advanced Custom Fields
• Live reloading
• A build script for generating commercial distributions

License

Ship is released under the terms of the GPL version 2 or (at your option) any later version, _(*3)

Support

If you need or can support this project, please head over to issues, _(*4)

Changelog

See changelog, _(*5)

Starting a new project

You'll need to have Composer installed., _(*6)

1. Open your terminal
2. Run composer create-project withfatpanda/ship "your/theme/path"
3. Answer the on-screen questions

Development

Ship wants your workflow to be as painless as possible. Below we move quickly through several topics that might be new to you, among them Dependency Management, Builds, and Asset Loading., _(*7)

For those of you who want a quicker start instead, it goes something like this:, _(*8)

• Install Composer and NPM
• Create a new Ship project (your theme) with composer: composer create-project withfatpanda/ship "path/to/your/project"
• Install front-end dependencies: npm install
• Start your watcher (builds your front-end in the background as you edit your code): npm build watch
• Put your theme's scripts into src/js/theme.js
• Build Customizer features in src/js/customizer.js
• Style your theme in src/sass/theme/_theme.scss
• Style the content in the admin editors in src/sass/custom-editor-style.scss
• Finish dev, test, distribute

Installing Dependencies

All of Ship's JS and CSS is built upon a core set of dependencies, chief among them being Bootstrap., _(*9)

Your new build system, Laravel Mix, also loads as a dependency., _(*10)

All of these dependencies are managed through NPM. If you don't have NPM installed, you'll need to do that first., _(*11)

Next, from the root of your theme project, run npm install., _(*12)

All of your theme's dependencies will appear in a folder named node_modules/. There are going to be a lot of files—don't let this freak you out, and welcome to modern JavaScript development., _(*13)

Once your dependencies have loaded, you can test-build by running the following command: npm run dev., _(*14)

If you get a "Compiled successfully..." message, then it's all working. If you don't, post your issue here., _(*15)

Front-end source files

The JS and CSS source files that underpin your new theme are as follows—there are other files in there too, but those listed below are the ones relevant to learning this part:, _(*16)

├── src
    ├── img
    │   ├── header.jpg
    ├── js
    │   ├── customizer.js
    │   └── theme.js
    └── sass
        ├── theme
        │   ├── _theme.scss
        │   └── _variables.scss
        ├── custom-editor-style.scss
        └── theme.scss

You'll want to put your theme's JavaScript into src/js/theme.js and/or load other modules of code into that file., _(*17)

You'll want to put your theme's styles into src/sass/theme/_theme.scss and/or load other modules of code into that file., _(*18)

Other front-end source files:

img/header.jpg is an example so that you know where to place static imagery for your theme; files placed here are optimized and copied to public assets during the build, _(*19)

js/customizer.js is where you can write code that will load into the Customizer; there are some examples therein, _(*20)

js/theme.js is where you write code that will load into every view of your theme, _(*21)

sass/theme/_theme.scss is where you write SCSS for your theme's main stylesheet, _(*22)

sass/theme/_variables.scss is where you set variables that influence Bootstrap's styles as well as those in your theme, _(*23)

sass/custom-editor-style.scss is where you write SCSS to generate a stylesheet that loads inside TinyMCE; the default just loads your theme's main stylesheet and adds some padding to the <body> tag, _(*24)

sass/theme.scss knits together all of your theme-specific SCSS code with Bootstrap, Font Awesome, and a bit of magic from the Underscores and UnderStrap projects, _(*25)

Building

Building your front-end code is as simple as running scripts with NPM at the command line. Just open your terminal, switch to the root of your theme project, and run any of the following:, _(*26)

npm run dev This will build your JS and CSS unminified and (when we finish building it) using development environment settings, _(*27)

npm run watch Use this command for active development sessions—it will build dev versions of your JS and CSS, unminified, and will begin "watching" your raw source files, recompiling them into the built output anytime you make a change, _(*28)

npm run hot Coming soon: Live Reloading; basically just like the watch command, except any changes to raw source files (including PHP files) result in your browser refreshing automatically, too, _(*29)

npm run production This will build minified and versioned copies of your JS and CSS, ready for distribution, _(*30)

npm run dist This will build distribution-ready copies of your JS and CSS, just like the production command; then, this command creates a clean copy of your theme in dist/ ready to ship without all of the dev stuff (build config files, raw JS and Sass code), _(*31)

Your built source files

Running any of the front-end build scripts above will generate and place files into an assets/ folder in the root of your project:, _(*32)

├── assets
    ├── css
    │   ├── custom-editor-style.css
    │   ├── custom-editor-style.css.map
    │   ├── theme.css
    │   └── theme.css.map
    ├── fonts
    │   └── ... all the fonts extracted during the build
    ├── img
    │   └── ... all the images from src/img
    ├── js
    │   ├── customizer.js
    │   ├── customizer.js.map
    │   ├── theme.js
    │   └── theme.js.map
    └── mix-manifest.json

The relationships between these compiled files and the raw source files should be fairly straight-forward (Tip: they're all named the same), but of special note is the mix-manifest.json file., _(*33)

The mix-manifest.json file, generated automatically during each build, establishes versions for your compiled files, i.e., versioning. When using asset loading (see below), the file version numbers are automatically appended to their URLs—this helps to force expiration of these resources from visitors' browsers, keeping their experience of your theme up-to-date., _(*34)

Loading assets

When loading a theme asset via PHP, use the global function asset($path) where $path is relative to your theme's assets folder. For example, invoking asset('css/theme.css') would generate a URL for your theme's main stylesheet. For an example in context, refer to the script src/php/inc/enqueue.php., _(*35)

Live reloading

Coming soon., _(*36)

Sass: Syntactically Awesome Style Sheets

If you're not using a CSS preprocessor to build your stylesheets, you're wasting a lot of time. If you've only ever used LESS, making the leap to Sass is fairly straightforward, and like us, we think you'll find Sass to be more robust and better-supported. Learn more about Sass here., _(*37)

ES6 and CommonJS

More details coming soon., _(*38)

Customizing your build

Your front-end build is powered by NPM and Laravel Mix (Webpack). The build commands described above in Building can be found in your package.json file in the section named scripts. They all ultimately invoke Webpack builds by way of Laravel Mix., _(*39)

Laravel Mix can be configured by editing webpack.mix.js. Most of the functions available to you for automating your builds are listed in this configuration file. You can also read Mix's documentation here., _(*40)

RTL styles?

Just add a new file to the themes root folder called rtl.css. Add all alignments to this file according to this description: https://codex.wordpress.org/Right_to_Left_Language_Support, _(*41)

Single-Page Application Themes

Coming soon., _(*42)

Licenses & Credits

• Sage: https://roots.io/sage
• UnderStrap: https://understrap.com (GPL version 2)
• Font Awesome: http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
• Bootstrap: http://getbootstrap.com | https://github.com/twbs/bootstrap/blob/master/LICENSE (Code licensed under MIT documentation under CC BY 3.0.) and of course
• jQuery: https://jquery.org | (Code licensed under MIT)
• WP Bootstrap Navwalker by Edward McIntyre: https://github.com/twittem/wp-bootstrap-navwalker | GNU GPL
• Bootstrap Gallery Script based on Roots Sage Gallery: https://github.com/roots/sage/blob/5b9786b8ceecfe717db55666efe5bcf0c9e1801c/lib/gallery.php

, _(*43)