Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marcobiedermann/ui

🦄 Collection of web UI components
https://github.com/marcobiedermann/ui

components css design-system javascript modules react storybook styleguide ui

Last synced: 8 days ago
JSON representation

🦄 Collection of web UI components

Awesome Lists containing this project

README

        

# UI Components

[![Build Status](https://travis-ci.com/marcobiedermann/ui.svg)](https://travis-ci.com/marcobiedermann/ui)
[![dependencies Status](https://david-dm.org/marcobiedermann/ui/status.svg)](https://david-dm.org/marcobiedermann/ui)
[![devDependencies Status](https://david-dm.org/marcobiedermann/ui/dev-status.svg)](https://david-dm.org/marcobiedermann/ui?type=dev)
[![Netlify Status](https://api.netlify.com/api/v1/badges/a63d0bca-710f-49c5-9d1e-a6e74725e959/deploy-status)](https://app.netlify.com/sites/marcobiedermann-ui/deploys)
[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg)](https://marcobiedermann-ui.netlify.app/)

## Table of contents

- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Storybook](#storybook)
- [Testing](#testing)
- [Publish](#publish)

## Requirements

- [Node.js](https://nodejs.org)

## Installation

```sh
npm install
```

## Usage

### Storybook

Launch Storybook development server with hot module replacement.

```sh
npm run develop
```

Build Storybook for production into `docs` folder.

```sh
npm run build
```

### Testing

Run all tests and linting.

```sh
npm test
```

Run CSS and JavaScript linting.

```sh
npm run lint
```

Run CSS linting.

```sh
npm run lint:css
```

Run JavaScript linting.

```sh
npm run lint:js
```

```sh
npm run publish
```