Skip to content

Latest commit

 

History

History
301 lines (261 loc) · 13.5 KB

RMDraft.md

File metadata and controls

301 lines (261 loc) · 13.5 KB

Project logo

Welcome to DRY-UI

Status GitHub Issues GitHub Pull Requests License

React components for faster and easier web development. This is a design system based on Material-UI.


🧐 About

Dry-UI is a Material-UI React library based on a theme design from Figma.


🏁 Getting Started

See our documentation with live editable examples and API documentation.

Prerequisites

What things you need to install the software and how to install them.

react
react-dom
Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

npm install dry-ui
or
yarn install dry-ui
Available Scripts

In the project directory, you can run:

npm dev
or
yarn dev

Runs the app in the development mode. Open http://localhost:6006 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.

npm test
or
yarn test

Launches the test runner in the interactive watch mode. See the create-react-app's section about running test for more information.

npm build-storybook
or
yarn build-storybook

Builds the app stories.

npm build-components
or
yarn build-components

Builds the components design system. It will create a dist folder.

npm publish
or 
yarn publish

Builds components and publishes to npm.


🎈 Usage

See our documentation with live editable examples and API documentation.


⛏️ Built Using

  • React - A JavaScript library for building user interfaces
  • Material-UI - React Component Library with Material Design
  • NodeJs - Server Environment

✍️ Authors