Skip to content

betterplace/betterplace-design-system

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Betterplace Design System

This is the repository for betterplace's design system.

The system uses Storybook as a tool for developing a component library, guidelines and documentation, that work across all betterplace platforms.

🔧 Setup

  1. git clone [email protected]:betterplace/betterplace-design-system.git
  2. cd betterplace-design-system
  3. yarn install
  4. yarn storybook

Dependencies

See .tool-versions

💻 Development

Scripts

Command Description
yarn storybook Start and open storybook in the browser.
yarn build-storybook Build static storybook output.
yarn build-tokens Generate all CSS variables from tokens.

Design Tokens

We use Design Tokens exported by Figma Tokens and generate CSS variables from these tokens using Style Dictionary.

The tokens input file is located in config/tokens.json (the exported file from Figma). The generated output is located in the build folder. Each theme is generated into its own file with variables, that would override each other. This is by design, because we only include one of these at a time. For example, theme org would include build/css/themes/org.css. Additionally, a globals.css is generated, which includes only unique global tokens.

To re-generate tokens with style-dictionary, run the following command: yarn build-tokens

📦 Data model

🧪 Tests

🚢 Deployment

📒 Further documentation

📖 License

Copyright 2022, gut.org gAG

Packages

No packages published

Contributors 9