Skip to content
Fractal/Mudstone Frontend Boilerplate
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__snapshots
__tests__
cert
comp-templates
deploy
gulp
src
.babelrc
.browserslistrc
.deployignore
.editorconfig
.eslintignore
.eslintrc
.gitignore
.htmlhintrc
.komp
.npmignore
.nvmrc
.prettierrc
.stylelintrc
CHANGELOG.md
Notes.md
README.md
gulpfile.js
jsdoc.json
package.json
setup-jest.js
wallaby.config.js
yarn.lock

README.md

mud-fractal

Mud

Webpack / Gulp / Fractal

Frontend starter kit integrated with Fractal, inspired by Blendid, powered by gulp, webpack.

All of the build/task dependencies are managed through a single npm package. mulp

Docs

Workflow

Structure

JS Setup

Getting started

Clone the repo… and install

Installation

yarn / npm install

Dev mode

Start fractal server

npm start

With craft

npm run cms

Builds

Create a library build

npm run build:fractal

Create a production build

npm run build

Create an optimised build with critical/purge css

npm run build:production

Build fractal components

npm run build:components

Create a static build (see publish settings in gulp/path.config.json)

npm run build:static

Unit and regression tests

Save a snapshot of components for regression testing

npm run reference

Test against the snapshots with an optimised build

npm run diff

Run any tests with jest

npm run test

Run tests in watch mode

npm run test:watch

Get a test coverage report

npm run coverage

Deployment (netlify)

If you have netlify setup, you can deploy the fractal library with this

npm run deploy

https

Create https certs for browsersync

npm run gen-cert

Linting/formatting

Lint all the javascript feels

npm run lint:js

Format all the code with prettier

npm run pretty

Generate documentation

npm run generate-docs

Fractal helpers

The following commands require komp: https://github.com/FrancisVega/komp (npm i -g komp)

Scaffold new objects/components/etc

komp new --template fractal ./02-objects/example-obj

komp new --template fractal ./03-globals/example-global

komp new --template fractal ./04-components/example-component

Scaffold new page

komp new ./05-objects/example-page --template page

Postcss plugins available:

You can’t perform that action at this time.