Skip to content

uasd7/design-system

 
 

Repository files navigation

Chefkoch Design System

Build Status

This repository contains the Chefkoch Design System. Its patterns and documentation are built with Astrum.

Showcase: http://design.chefkoch.de

Contents

Installation & Usage

Maintain the design-system with docker

docker run --rm -v $(pwd):/app -w="/app" node npm install|update

Usage Requirements

  • Sass

Install the design patterns and add them in anyway you see fit to your build pipeline.

npm install chefkoch-design-system --save-dev

Integration in the pipeline, example with gulp and gulp-sass sass({ includePaths: ['node_modules/chefkoch-design-system/patterns/'] })

Import the desired pattern in your sass file Ein Pattern aus dem Design-System muss erst per scss eingebunden werden:

@import 'button/button'

Use the imported component in your markup

<button class="ds-button ds-button--standard">Button-Element als Button</button>

Contributing

Take a look at the development and contributing guidelines if you are in the mood of extending the design system.

Please make sure to read the disclaimer first.

Disclaimer

The Chefkoch Design System is a library for internal usage by the Chefkoch GmbH, its publication on Github and npm is mainly in the spirit of providing another implementation reference for display patterns and design systems.

We do not encourage its usage for other websites.

Packages

No packages published

Languages

  • HTML 46.0%
  • CSS 39.2%
  • JavaScript 14.8%