Nonlinear Performance Magnification
Miss any of our Open RFC calls?Watch the recordings here! »

@readme/ui

1.15.1 • Public • Published

ReadMe UI

Owlblocks! a UI component library and design system for ReadMe's front end.

npm install -S @readme/ui

Workflow

Run these commands to develop and document UI components locally:

npm start     # start the local Styleguidist dev server 
npm test      # run tests against the UI library 
npm run watch # watch and rebuild, for local linked dev 

Creating New Components

Use the new:elem command to quickly scaffold out a new component or composition:

npm run elem -- MyUIElement "composition" # or "component" by default 

Architecture

From a birdseye view: (the meaty stuff lives in the ui/ directory, obviously!)

src/
│ ui/             # UI component library: 
│ ├ components/   # - lower-level UI building blocks 
│ └ compositions/ # - higher-order UI constructs 
└ styles/         # SCSS vars, mixins; CSS resets; etc. 

Under the Hood

This repository brings together a number of utilities and tools for various front end development workflows:

Dependencies
React & Sass for components and styling
Styleguidist to power our living documentation
Babel & Webpack/NWB for transpiling and compilation
Lodash for various Javascript utility methods

Install

npm i @readme/ui

DownloadsWeekly Downloads

2,576

Version

1.15.1

License

ISC

Unpacked Size

9.43 MB

Total Files

421

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar