@un/create-design-system

Create Design System

Create Design System is a tool to initialize a design-system boilerplate with no build configuration.

Quick Overview

npx @un/create-design-system my-design-system
cd my-design-system
yarn react:start

Alpha releases

npx @un/create-design-system@alpha my-design-system

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)

Then open http://localhost:3000/ to see your app.
When you’re ready to deploy to production, create a minified bundle with npm run build.

Creating an App

You’ll need to have Node 14.0.0 or later version on your local development machine (but it’s not required on the server). We recommend using the latest LTS version. You can use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects.

You also need yarn since we are using yarn workspaces in the default configuration.

To create a new app, you may choose one of the following methods:

npx

npx @un/create-design-system my-design-system

(npx is a package runner tool that comes with npm 5.2+ and higher, see instructions for older npm versions)

Yarn

yarn create @un/design-system my-design-system

yarn create <starter-kit-package> is available in Yarn 0.25+

It will create a directory called my-design-system inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies: