This is the project scaffolding used for all of my Craft CMS projects. It integrates the Augmented ITCSS Architecture, as well as the Craft CMS Template Scaffolding.
Download or clone this project scaffold into your working directory, and then run:
$ npm installUse Node.js scripts to run build tools.
$ npm run watch- Recompiles files whenever they change.$ npm run build- Creates production ready code.
After running $ npm run watch or $ npm run build, your deploy-ready code will be taken from the ./src/ directory and placed within the ./public/build/ directory of your project. However, the webpack generated templates will be placed within the ./public/static/templates/_webpack.templates directory of your project so Craft CMS has access to them.
This project scaffolding is pretty opinionated and makes use of the following tools, open source projects, and architecture methodologies:
- webpack - A bundler for javascript and friends.
- Sass - CSS extension language
- ECMAScript 2015 modules - JavaScript's built-in modules.
- SMACSS - Methodology for organizing scalable and modular CSS architectures
- BEM - Block Element Modifier is a methodology, that helps you to achieve reusable components and code sharing in the front-end
- Augmented ITCSS - This is an augmented css folder structure that originates from the ITCSS architecture and uses SMACSS and BEM.
- Modernizr - Modernizr tells you what HTML, CSS and JavaScript features the user’s browser has to offer.
- svg4everybody - Open source external SVG polyfill for useing external SVG spritemaps
- PictureFill - A responsive image polyfill for
, srcset, sizes, and more
Thanks to our developers who made this Craft CMS project scaffolding possible.
Copyright (c) 2017 MilesHerndon
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.