JSPM

wbu-design-system

1.1.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 60
  • Score
    100M100P100Q72713F
  • License MIT

WhereBy.Design is the nascent design system for WhereBy.Us

Package Exports

  • wbu-design-system

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (wbu-design-system) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

WhereBy.Design

A nascent, work-in-progress design system for WhereBy.Us built with Vue.

How to work with the design system

Developing locally is half the fun (!), and to start -- after cloning the repo -- all you need to do is run the following from inside the project directory:

npm install
npm start

This spins-up a local server where localhost:8080 is the "front page" of the system, which isn't suuuper useful, and -- more importantly -- localhost:6060 is the system's documentation (where we work most of the time).

Adding a New Design Component

You would make a SomeComponentName.vue in the appropriate directory in /src/, such as src/Elements, src/Patterns, or src/Templates.

There is an ExampleComponent.vue that you can look at for any design-system specific things, such as the <docs></docs> tag for the documentation part of the design system. Other than that, it's a straight Vue component.