Kyokan UI

Setup

npm run install-with-peers

Commands

npm run start                    # to start a style guide dev server

npm run generate [ComponentName] # to generate a scaffold for a new component

npm run build                    # to build a static version of the styleguide (for deployment)

npm publish                      # to publish to the NPM registry

NOTE: DO NOT USE yarn link IF YOU ARE USING styled-components in your own project - this might result in conflicting versions of styled-components.

Motivation

Primary concern: pleasurable authoring experience

Philosophies

• Michael Chan: https://www.youtube.com/watch?v=gNeavlJ7lNY
  • "depend on our own API"
• Glen Maddern: https://www.youtube.com/watch?v=qu4U7lwZTRI
  • build around your own desired API
  • using styled-components gives us all the power of JavaScript while solving the issue of global styles from CSS and the arbitrary class names from CSS modules
• Max Stoiber: https://www.youtube.com/watch?v=2j9rSur_mnk
  • "[best practices] are completely useless if they're not enforced"
  • no one is going to adhere to best practice that block you from getting things done