README

A ProcessWire starter site profile based on the wireframe output framework.

This project is intended as an opinionated starting point for sites powered by the wireframe module, and contains a number of site features that make more sense as a part of a site profile, rather than the wireframe module itself.

More details about the wireframe output framework: https://wireframe-framework.com
More details about the ProcessWire CMS/CMF: https://processwire.com

Git ignore (.gitignore) file

Please note that wireframe boilerplate includes an opinionated .gitignore file based on Bare Minimum Git (https://gist.github.com/salcode/10017553). Please make sure that this file suits your workflow, and modify it as necessary.

Purpose

Default .gitignore file serves two primary purposes: it keeps clutter out of your version control system, and – more importantly – it helps avoid slipping secrets into the VCS. Storing sensitive data (passwords, keys, etc.) in a VCS is considered a bad practice, and should be avoided.

Important considerations

Important considerations regarding the .gitignore file:

ProcessWire modules directory is ignored by default. Wireframe boilerplate expectes module files to be bundled using Composer, but you can also add specific module folders manually, or commment this rule out in .gitignore.
ProcessWire assets directory is ignored.
ProcessWire development config file (config-dev.php) and often used PHP environment variable file env.php are both ignored.
Files starting with a dot (.), a hash/pound character (#), or a tilde (~) are ignored.
Various types of temporary files, SQL databases and dumps, and packaged files are ignored. This includes any file with a .backup, .bak, .old, .tmp, or .temp suffix.
Composer, Node, Grunt, and Bower default install directories are ignored.

Installing modules without Composer

Since the /site/modules/ directory is by default included in the .gitignore file ignore rules, files added beneath it won't show up if you add them and type git status in the site directory. This is by design, since the wireframe boilerplate expects modules to be installed with Composer. That being said, installing modules without Composer and adding them to your version control system is easy:

Download or clone the module files into your /site/modules/ directory.
From your site directory, run git add -f modules/[module-folder].
- Note that the -f flag is very important – if you omit it, Git won't allow you to add content into an ignored folder!
Commit your newly added files to Git with git commit modules/[module-folder] .

Another way, obviously, would be to comment out or remove the line in the .gitignore file affecting the modules directory. If you really want to add all your module files and directories to Git, this is a perfectly fine thing to do. And finally, you can also manually add individual module folders into the "whitelisted files" section of your .gitignore file.

Whitelisted files

At the end of the .gitignore file you'll find a section for whitelisted files. If your site requires some one-off deviations from the base rules, the easy (and safe) way out would be including more rules here instead of removing earlier ignore rules.

Requirements

ProcessWire 3.0.112 or newer
PHP 7.1 or newer
Composer

Other requirements, such as ProcessWire modules, are installed with Composer.

Notes about composer.json

In case you're wondering why we're specifying ProcessWire itself as one of our requirements via the composer.json file even though we don't really need it (as a Composer requirement), this is a trick used to force Composer to install ProcessWire before the boilerplate in case they are both required in the same project.

Note: feel free to remove the ProcessWire requirement if you want to – that won't break anything.

How to install

Obtain a fresh copy of ProcessWire 3.0.112 or newer and upload/unzip it on your server.
Download or clone the contents of this repository into /site-wireframe-boilerplate/ within the directory you uploaded/unzipped ProcessWire to. You will see other site directories (including /site-default/) already there, but these can be safely ignored for the time being.
Go to the /site-wireframe-boilerplate/ directory and run composer install.
Install ProcessWire by accessing the URL it lives in with your web browser. When the installer asks you to choose a site profile, choose "Wireframe Boilerplate Site Profile".

License

This project is licensed under the Mozilla Public License Version 2.0.

wireframe-framework / site-wireframe-boilerplate

Maintainers

Details