https://github.com/skilld-labs/kaizen

Basic theme
https://github.com/skilld-labs/kaizen

components development-theme drupal-8 eslint postcss stylelint theme webpack

Last synced: 27 days ago
JSON representation

Basic theme

• Host: GitHub
• URL: https://github.com/skilld-labs/kaizen
• Owner: skilld-labs
• Created: 2018-12-18T05:07:28.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-11-21T21:10:11.000Z (almost 2 years ago)
• Last Synced: 2024-07-26T16:02:38.666Z (3 months ago)
• Topics: components, development-theme, drupal-8, eslint, postcss, stylelint, theme, webpack
• Language: JavaScript
• Size: 1.71 MB
• Stars: 8
• Watchers: 14
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# kaizen

        _/                       _/

       _/  _/       _/_/_/             _/_/_/_/       _/_/       _/_/_/

      _/_/       _/    _/      _/         _/       _/_/_/_/     _/    _/

     _/  _/     _/    _/      _/       _/         _/           _/    _/

    _/    _/     _/_/_/      _/     _/_/_/_/       _/_/_/     _/    _/

## What is this?

- This is a developer theme for Drupal 8, 9 and 10

## Requirements

- Docker-ce

Or

- Node.js

- Yarn

## Features

- PostCss

- Storybook

- Webpack

- Browsersync

- eslint

- stylelint

- Autoprefixer

- Drupal Color Module support

- Drupal breakpoints.yml config parser in css/js

- Svg sprite generation

- Several basic helpers which improves quality and perception of the web-sites. [Read more](https://github.com/skilld-labs/kaizen/tree/master/packages/kaizen-core)

## Usage

1. `cd web/themes/custom`

2. `npx @skilld/kaizen-tg` and follow instructions. Or alternative installation using Docker `docker run -it --rm -u $(id -u):$(id -g) -v "$PWD":/app -w /app node:lts-alpine npx @skilld/kaizen-tg`

3. `cd [theme_name]`

4. `yarn && yarn build` or `make install && make build` if you want to use docker instead of local

## Components creation

Run `yarn cc` from theme dir

## Storybook

Run `yarn storybook` from theme dir to init storybook

## Linting and fixing

Run `yarn lint-fix` from theme dir

## Contrib

Please contrib into kaizen if you have ideas or problems. We are on [github](https://github.com/skilld-labs/kaizen). Feel free to open discussion or create pull requests.

# License

This project is licensed under the MIT open source license.