https://github.com/isthatcentered/emulsify_starter
https://github.com/isthatcentered/emulsify_starter
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/isthatcentered/emulsify_starter
- Owner: isthatcentered
- Created: 2018-01-08T09:35:53.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-10T18:49:52.000Z (over 8 years ago)
- Last Synced: 2025-07-11T11:52:17.861Z (11 months ago)
- Language: HTML
- Size: 1.72 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://fourkitchens.com/)
# custom: Pattern Lab + Drupal 8
Component-driven prototyping tool using [Pattern Lab v2](http://patternlab.io/) automated via Gulp/NPM. Also serves as a starterkit Drupal 8 theme.
## Requirements
1. [Node (we recommend NVM)](https://github.com/creationix/nvm)
2. [Gulp](http://gulpjs.com/)
3. [Composer](https://getcomposer.org/)
4. Optional: [Yarn](https://github.com/yarnpkg/yarn)
## Quickstart (custom Standalone)
custom supports both NPM and YARN.
Install with NPM:
`composer create-project fourkitchens/custom --stability dev --no-interaction custom && cd custom && npm install`
Install with Yarn:
`composer create-project fourkitchens/custom --stability dev --no-interaction custom && cd custom && yarn install`
## Drupal-specific installation
### In a Composer-based Drupal install (recommended)
1. `composer require fourkitchens/custom`
2. Enable custom and its dependencies `drush en custom components unified_twig_ext -y`
3. **Optional**: Create cloned theme `drush custom "THEME NAME"` (You may need to run `drush cc drush` to clear the drush cache. Also, you can run `drush help custom` for other available options)
4. If you created a cloned theme, `cd web/themes/custom/THEME_NAME/`. If not, `cd web/themes/contrib/custom/`
5. `npm install` or `yarn install`
If you're not using a Composer-based Drupal install (e.g. tarball download from drupal.org) installation [instructions can be found on the Wiki](https://github.com/fourkitchens/custom/wiki/Installation).
Troubleshooting Installation: See [Drupal Installation FAQ](https://github.com/fourkitchens/custom/wiki/Installation#drupal-installation-faq).
## Starting Pattern Lab and watch task
The `start` command spins up a local server, compiles everything (runs all required gulp tasks), and watches for changes.
1. `npm start` or `yarn start`
---
## Highlighted Features
Lightweight✔custom is focused on being as lightweight as possible.
SVG sprite support ✔Automated support for creating SVG sprites mixins/classes.
Stock Drupal templates ✔Templates from Stable theme - see /templates directory
Stock Components ✔with Drupal support built-in (https://github.com/fourkitchens/custom#customs-built-in-components-with-drupal-support)
Performance Testing ✔Support for testing via Google PageSpeed Insights and WebPageTest.org (https://github.com/fourkitchens/custom/wiki/Gulp-Config#performance-testing)
Automated Github Deployment ✔Deploy your Pattern Lab instance as a Github page (https://github.com/fourkitchens/custom/wiki/Gulp-Config#deployment)
custom's Built in Components with Drupal support
Forms, tables, video, accordion, cards, breadcrumbs, tabs, pager, status messages, grid
View a [demo of these default custom components](https://fourkitchens.github.io/custom/pattern-lab/public/).
## Documentation
Documentation is currently provided in [the Wiki](https://github.com/fourkitchens/custom/wiki). Here are a few basic links:
#### General Orientation
See [Orientation](https://github.com/fourkitchens/custom/wiki/Orientation)
#### For Designers (Prototyping)
See [Designers](https://github.com/fourkitchens/custom/wiki/For-Designers)
#### For Drupal 8 Developers
See [Drupal Usage](https://github.com/fourkitchens/custom/wiki/Drupal-Usage)
#### Gulp Configuration
See [Gulp Config](https://github.com/fourkitchens/custom/wiki/Gulp-Config)