Review Me Design System

This is a shared component library incorporating Review Me's design system. Before getting started, please refer to the Storybook link below.

storybook

Installation

npm

npm i review-me-design-system

yarn

yarn add review-me-design-system

Getting Started

1. Wrap your application with the ReviewMeProvider provided by review-me-design-system

   import { ReviewMeProvider } from 'review-me-design-system';
   
   <ReviewMeProvider>
     <App />
   </ReviewMeProvider>;

2. Import components from review-me-design-system and use the imported components

   import { Icon, Button } from 'review-me-design-system';
   
   const Component = () => {
     return (
       <>
         <div>component</div>
         <Icon iconName="bookMark" />
         <Button variant="default" size="s">
           button
         </Button>
       </>
     );
   };

Links

npm

storybook