This probably isn't the repository you're looking for anymore. This repository is no longer being kept up to date, with all development happening on imarc/boilerplate-components, the full version of our framework.
This is a framework for frontend development. It includes
- Support for Sass,
- A Pattern Library (powered by Fractal), and
- A Front End Build (powered by Laravel Mix.)
This is the slimmed down version of imarc/boilerplate-components as it starts with only the utilities and base files from that repository.
If you want to slim down what's provided even more, you can change $use-boilerplate-classes to false in variables.scss to disable all the classes and only get mixins. (You will still get classes from Slick and FontAwesome.)
While we encourage you to read the builtin documentation, some highlights are
- Uses Atomic Design
- Uses ABEM
- Uses Twig
Some components were carried over from version 3, but were not updated to the latest practices and syntax. These are flagged as DEPRECATED within the pattern library, and may be removed entirely in a future release.
Within a new project, make sure you first have an existing package.json. If you don't have one, you can create one by running
npm init -y
After that, run
npx imarc/boilerplate
NPX should automatically copy the resource folder to your project, add dependencies to your package.json, and even add scripts to your package.json file.
After running npx above, your project will be automatically setup so you can run
npm run devto run the development build (make sourcemaps, don't minify, etc.)npm run prodto run the production build.npm run watchto watches files for changes and automatically re-run the development build.
To locally serve the pattern library:
npm run fractal start -wto run a local server and watch for changes
And lastly, to build the pattern library:
npm run fractal build
You can customize this behavior further by editing either the webpack.mix.js or fractal.js files per the Laravel Mix or Fractal documentation respectively.