A starter kit for using the prototyping tool, Pattern Lab, in tandem with a Drupal and Grav theme. Utilizes Webpack for all asset management.
HTML JavaScript CSS PHP
Permalink
Failed to load latest commit information.
apps Stylelint performance improvements by moving to standalone .stylelint… Jun 19, 2018
source Remove rogue slash in image. Again. Jun 29, 2018
tools Ignore more system files during yeoman new. Jun 28, 2018
.babelrc Configure babel to actually use the browserlist entry in package.json Jul 9, 2018
.editorconfig Track editorconfig to make composer more standard Nov 13, 2017
.eslintignore update templates for particle Mar 27, 2018
.eslintrc.js Add root:true to eslintrc to that eslint will not travel up to parent… Jun 26, 2018
.gitignore Set NODE_ENV in PL via gulp, new package.json scripts Mar 3, 2018
.htaccess Create .htaccess so Pattern Info shows. Jan 31, 2017
.huskyrc Another ugly commit. Jun 19, 2018
.prettierignore Prettier steps on our scss in yeoman generator. Jun 26, 2018
.prettierrc.js Prettier config, estlint update, airbnb update, package.json cleanup … Jun 19, 2018
.stylelintignore Ingore formatting. Jun 19, 2018
.stylelintrc Stylelint performance improvements by moving to standalone .stylelint… Jun 19, 2018
.travis.yml update travis to use npm@latest, and then npm ci Mar 28, 2018
.yo-rc.json Prettier all the things Mar 5, 2018
LICENSE Update license to GPL2 and add in package.json Aug 5, 2017
README.md Add instructions for installing dependencies to README.me Jun 5, 2018
config.js Goodbye webpack gulp task. Now we simply write a single timestamp fil… Feb 27, 2018
contributing.md editorconfig notes in contributing.md, wording in readme to sound les… Nov 13, 2017
gulpfile.js Prettier config, estlint update, airbnb update, package.json cleanup … Jun 19, 2018
jest.config.js Prettier config, estlint update, airbnb update, package.json cleanup … Jun 19, 2018
package-lock.json Ignore more system files during yeoman new. Jun 28, 2018
package.json Update eslint-plugin-import update to meet requirements. Jun 26, 2018
particle.yaml Update comment in particle.yaml config Dec 7, 2017
webpack.particle.dev.js Fix up dev/prod webpack config for new linter Jun 26, 2018
webpack.particle.prod.js Fix up dev/prod webpack config for new linter Jun 26, 2018

README.md

Particle: A design system integrating to Pattern Lab and a Drupal 8 theme

GitHub (pre-)release Build Status Greenkeeper badge

Particle mascot: Astrogoat

Particle is an opinionated set of tools and examples to:

  1. Build an application-agnostic design system
  2. Apply that design system to a locally-served Pattern Lab for rapid prototyping
  3. Apply that design system to a Drupal theme

In depth documentation about frontend approach using this project at Phase2 Frontend Docs

Prerequisites

Step-by-step instructions to install all dependencies for OSX can be found in this Gist.

Provides

  • Drupal theme, Grav theme, and Pattern Lab app
  • Strict Atomic Design component structure
  • Webpack bundling of all CSS, javascript, font, and static image assets for multiple targets (Drupal theme, Grav theme, Pattern Lab)
  • Webpack Dev Server for local hosting and hot reloading of assets into Pattern Lab
  • Twig namespaced paths automatically added into Drupal theme and Pattern Lab config. Within any twig file, @atoms/thing.twig means the same thing to Drupal theme and Pattern Lab.
  • Iconfont auto-generation
  • Bootstrap 4 integration, used for all starting example components
  • Auto-linting against the AirBnB JavaScript Style Guide and sane Sass standards
  • All Webpack and Gulp files are fully configurable
  • Simple Yeoman generator for Design System component creation

Quickstart

Particle builds design systems in dev mode for local hosting, or production mode for optimized asset generation.

Quickstart anywhere

  1. Download the latest release
  2. Extract anywhere (i.e. this readme should be at any/where/particle/README.md)
  3. Within the extracted folder run:
npm install
npm run setup
npm start

Simply wait until the webpack bundle output appears then visit http://0.0.0.0:8080/pl (or http://localhost:8080/pl) and start working.

That's it. For much greater detail on the frontend approach using this project, check out the Phase2 Frontend Docs.