Intro

Last updated 6 months ago

Particle is an opinionated set of tools and examples to:

  1. Build one or more application-agnostic design systems made of assets like Twig, Sass, JavaScript, images, etc

  2. Apply those design systems to a locally-served Pattern Lab for rapid prototyping

  3. Apply those design systems to other consuming apps like, Drupal, Grav, or (soon) Wordpress

Particle Features

  • Drupal theme, Grav theme, Pattern Lab instance

  • Strict Atomic Design component structure

  • Robust Webpack bundling of all CSS, JavaScript, font, and static assets for multiple targets

  • 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

  • PostCSS automation and expansion, with Autoprefixer.

Documentation To-Do List

  • Go over basics of Pattern Lab, the specific way Particle has Pattern Lab set up by default, and suggested uses.

  • Folder & config structure need updated to current Webpack structure

  • Explain Particle.js and how the Particle() function smashes various Webpack configs together

  • Explain Webpack structure (CSS modes, etc.)

  • Expand on technologies Particle automatically includes to make Sass/JS faster.

  • Troubleshooting cleanup ("nothing to see here", datetime error?, etc.)

  • Testing notes (Jest, Pa11y, Cypress?)

  • Vue-related notes

  • Example workflows

  • Flesh out the "thinking" sections

  • Update the Drupal apps section (what goes here vs. Drupal under Frontend?)