v3/packages/design-system
Katalina 7d681d69d6
Feat/editor category pass2 (#290)
* feat(design-system): add editor skeletons

* use css media queries rather than JS media queries

* init remake

* feat: add basis of toggle atom

* finish toggle

* use pointer cursor with toggle

* sync

* feat: add server message in editor

* cleanup storybook

* add short editor item and data model for categories

* chore: fix build by moving jest version downward

* chore: remove old category editor

* chore: fix EditorCategoryShort index

* add editor wiring and styling updates

* fix linting issues
2021-07-05 12:18:40 -05:00
..
.storybook Feat/editor category pass2 (#290) 2021-07-05 12:18:40 -05:00
atoms Feat/editor category pass2 (#290) 2021-07-05 12:18:40 -05:00
fixtures chore: update prettier tab width for consistency (#175) 2021-03-13 22:54:34 -05:00
molecules Feat/editor category pass2 (#290) 2021-07-05 12:18:40 -05:00
organisms Feat/editor category pass2 (#290) 2021-07-05 12:18:40 -05:00
templates Feat/editor category pass2 (#290) 2021-07-05 12:18:40 -05:00
Intro.stories.mdx Refactor node packages to yarn workspaces & ditch next.js for CRA. (#161) 2021-03-12 18:04:49 -05:00
package.json Feat/editor category pass2 (#290) 2021-07-05 12:18:40 -05:00
README.md Refactor node packages to yarn workspaces & ditch next.js for CRA. (#161) 2021-03-12 18:04:49 -05:00
tsconfig.json chore: update prettier tab width for consistency (#175) 2021-03-13 22:54:34 -05:00

Roleypoly Design System

Codename: rapid

The Roleypoly Design System (rapid) is an atomic design system to help rapidly and consistently build Roleypoly and related services. The color system in use is deliberately simple, and should be adhered to.

Developing

Please follow hermeticity considerations.

This package cannot reference RPC types, as they do not exist in the outside world. Storybook is the core component of this, and Storybook doesn't know how to find RPC types at CI build time, as Bazel is also not present. If you are worried about RPC types being compatible, please write a unit test and include the RPC types then.

You need:

  • node (lts or later)
  • yarn (v1.x)

Run:

  • yarn storybook to get started.

Atomic Design 101

Components are split into the following categories:

  • atoms
    • smallest possible parts.
    • typically individual pieces, such as branding, layout macros, and style-wrapped native elements.
  • molecules
    • groups of atoms
    • typically these make up sections of major UI parts
  • organisms
    • groups of molecules
    • typically these are major UI parts
  • templates
    • groups of organisms
    • typically a full page, without data.
  • pages
    • not covered by rapid
    • routes data into templates.

This sort of layout works extremely well with Next.js, the UI toolkit within Roleypoly. You should also be able to develop most parts, up until pages, directly within Storybook.