{"id":13397680,"url":"https://github.com/phase2/particle","last_synced_at":"2025-05-15T00:13:45.930Z","repository":{"id":30078393,"uuid":"33627949","full_name":"phase2/particle","owner":"phase2","description":"A starter kit for using the prototyping tool, Pattern Lab, in tandem with a Drupal theme. Utilizes Webpack for all asset management.","archived":false,"fork":false,"pushed_at":"2025-04-30T16:25:34.000Z","size":19007,"stargazers_count":315,"open_issues_count":80,"forks_count":116,"subscribers_count":36,"default_branch":"main","last_synced_at":"2025-04-30T17:39:19.878Z","etag":null,"topics":["drupal-theme","gulp","pattern-lab","webpack4"],"latest_commit_sha":null,"homepage":"https://phase2.gitbook.io/frontend/","language":"Twig","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phase2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-04-08T19:34:53.000Z","updated_at":"2025-03-04T21:37:27.000Z","dependencies_parsed_at":"2022-08-19T18:00:55.566Z","dependency_job_id":"77dc2fb7-2004-4d24-8a5e-664fb9f91eeb","html_url":"https://github.com/phase2/particle","commit_stats":{"total_commits":1672,"total_committers":57,"mean_commits":"29.333333333333332","dds":0.6686602870813397,"last_synced_commit":"71759d3d60e2b1cd7033b503b9d17356c3480562"},"previous_names":["phase2/pattern-lab-starter"],"tags_count":70,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phase2%2Fparticle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phase2%2Fparticle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phase2%2Fparticle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phase2%2Fparticle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phase2","download_url":"https://codeload.github.com/phase2/particle/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254249206,"owners_count":22039029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["drupal-theme","gulp","pattern-lab","webpack4"],"created_at":"2024-07-30T18:01:38.806Z","updated_at":"2025-05-15T00:13:40.871Z","avatar_url":"https://github.com/phase2.png","language":"Twig","readme":"# Particle: A design system integrating to Pattern Lab and a Drupal 8 theme\n\n[![GitHub (pre-)release](https://img.shields.io/github/release/phase2/particle/all.svg)](https://github.com/phase2/particle/releases)\n[![Build Status](https://travis-ci.org/phase2/particle.svg?branch=main)](https://travis-ci.org/phase2/particle)\n[![Greenkeeper badge](https://badges.greenkeeper.io/phase2/particle.svg)](https://greenkeeper.io/)\n\n![Particle mascot: Astrogoat](apps/pl-default/pattern-lab/_patterns/01-atoms-demo/image/astrogoat.png?raw=true 'Astrogoat')\n\nParticle is an opinionated set of tools and examples to:\n\n1.  Build an application-agnostic **design system**\n1.  Apply that design system to a locally-served **Pattern Lab** for rapid\n    prototyping\n1.  Apply that design system to a **Drupal theme**\n\nIn depth documentation about frontend approach using this project at\n[Phase2 Frontend Docs](https://phase2.gitbook.io/frontend/)\n\n## Prerequisites\n\n- [Node `^8`, `^10`, `^12`](https://nodejs.org)\n- [NPM `^5`, `^6`](https://www.npmjs.com/)\n- [PHP `^7`](https://php.net)\n\n[Step-by-step instructions to install all dependencies for OSX can be found in this Gist.](https://gist.github.com/illepic/efd6ab9f452af2a99b7ade78257e6b96)\n\n## Provides\n\n- Drupal theme, Grav theme, and Pattern Lab app\n- Strict [Atomic Design](http://atomicdesign.bradfrost.com/) component structure\n- Webpack bundling of all CSS, javascript, font, and static image assets for\n  multiple targets (Drupal theme, Grav theme, Pattern Lab)\n- [Webpack Dev Server](https://github.com/webpack/webpack-dev-server) for local\n  hosting and hot reloading of assets into Pattern Lab\n- [Twig namespaced paths](https://symfony.com/doc/current/templating/namespaced_paths.html)\n  automatically added into Drupal theme and Pattern Lab config. Within any twig\n  file, `@atoms/thing.twig` means the same thing to Drupal theme and Pattern\n  Lab.\n- Iconfont auto-generation\n- Auto-linting against the\n  [AirBnB JavaScript Style Guide](https://github.com/airbnb/javascript)\n- All Webpack files are fully configurable\n- Simple [Yeoman](http://yeoman.io/) generator for Design System component\n  creation\n\n## Quickstart\n\nParticle builds design systems in dev mode for local hosting, or production mode\nfor optimized asset generation.\n\n### Quickstart A\n\n1. Simply run:\n\n   ```bash\n   npm create @phase2/particle particle\n   ```\n\n1. Then `cd particle/` and run:\n\n   ```bash\n   npm start\n   ```\n\n### Quickstart B\n\n1.  [Download the latest release](https://github.com/phase2/particle/releases)\n1.  Extract anywhere (i.e. this readme should be at\n    `any/where/particle/README.md`)\n1.  Within the extracted folder run:\n\n```bash\nnpm install\nnpm run setup\nnpm start\n```\n\nSimply wait until the webpack bundle output appears then visit\n[http://0.0.0.0:8080/app-pl/pl/](http://0.0.0.0:8080/app-pl/pl/) (or\n[http://localhost:8080/app-pl/pl/](http://localhost:8080/app-pl/pl/)) and start\nworking.\n\nThat's it. For **much** greater detail on the frontend approach using this\nproject, check out the\n[Phase2 Frontend Docs](https://phase2.gitbook.io/frontend/).\n\n## Design System Naming\n\nThe Design System Source folder is named default `./source/default`. It's handy\nin multi-design setups to name this per design system and post-fix `apps` with\nthat design system name. For example, `apps/drupal-default/` contains the\nimplementation of the `default` source directory. These are intended to be\nupdated by the needs of your project.\n","funding_links":[],"categories":["HTML","Drupal themes and design systems with Drupal integration"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphase2%2Fparticle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphase2%2Fparticle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphase2%2Fparticle/lists"}