@stepzen/design-system
Advanced tools
This npm package includes design tokens, styles and UI components shared across different StepZen web apps: the docs and marketing site stepzen.com, the "My Account" dashboard dashboard.stepzen.com, etc.
This repo includes Storybook as a tool to visualise the contents of the design system, making it available on the web.
The Storybook for the main branch is automatically published to https://main--62ba1d9d935e74836cf81cae.chromatic.com/.
NOTE: it might take up to an hour after a push to main before changes appear on https://main--62ba1d9d935e74836cf81cae.chromatic.com/.
npm install --save @stepzen/design-systempages/_app.js
import "@stepzen/design-system/dist/css/index.css";
.css and .js / .ts files.Manual publishing steps:
git clone git@github.com:steprz/design-system.git --depth 1cd design-systemnpm cinpm version [new version]npm run buildnpm publishgit push (to push the version commit)git push --tags (to push the new version tag)#dev-products-frontend Slack channelGlobal style sheets set CSS custom properties on the HTML page :root and / or modify styles of the standard HTML elements such as <h1> or <body>.
How to add a new global style to the StepZen design system:
.css filesstylesheet-name.css file under src/styles (or src/styles/tokens for new design tokens)<link rel="stylesheet"> tagsrc/styles/index.css with a relative @import()[StylesheetName].stories.mdx file next to the stylesheet-name.css file (copy from one of the existing similar files)<Meta title="Design Tokens/Colors" /> tag in the copied file appropriately@stepzen/design-system package to npm (most likely, this would be a minor)import '@stepzen/design-system/dist/css/index.css' will get new global styles after bumping the version of their @stepzen/design-system npm dependency.TBD
Currently, the design system only includes a dummy sample Button component which is not intended for actual usage.
This repo uses NodeJS 16+ and npm 7+.
npm run build - (re)create a production design system bundle in the dist/ folder (includes .css, .js, and .d.ts files)npm run storybook - start a local Storybook server on http://localhost:6006npm run build-storybook - create a production storybook bundle in the storybook-static/ foldernpx chromatic --project-token=<project-token> - recreate a production srotybook bundle and publish it to chromatic.com. Copy the project token from https://www.chromatic.com/manage?appId=62ba1d9d935e74836cf81cae&view=configure. Typically you do not need to do that, since all branches on GitHub are automatically deployed to chromatic.com by the "Chromatic" GitHub workflow (see .github/workflows/chromatic.yaml).FAQs
StepZen design system
We found that @stepzen/design-system demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.