https://github.com/miare-ir/milingo

Miare design language
https://github.com/miare-ir/milingo

design-language react

Last synced: 15 days ago
JSON representation

Miare design language

• Host: GitHub
• URL: https://github.com/miare-ir/milingo
• Owner: miare-ir
• License: mit
• Created: 2018-11-12T11:36:38.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-02T11:06:30.000Z (6 months ago)
• Last Synced: 2024-10-17T07:38:45.426Z (29 days ago)
• Topics: design-language, react
• Language: TypeScript
• Size: 11.1 MB
• Stars: 16
• Watchers: 3
• Forks: 2
• Open Issues: 24
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![license](https://img.shields.io/npm/l/milingo.svg)](https://www.npmjs.com/package/milingo)

[![npm](https://badge.fury.io/js/milingo.svg)](https://badge.fury.io/js/milingo)

[![npm downloads](https://img.shields.io/npm/dt/milingo.svg)](https://www.npmjs.com/package/milingo)

[![npm bundle size](https://img.shields.io/bundlephobia/minzip/milingo)](https://www.npmjs.com/package/milingo)

[![node](https://img.shields.io/node/v/milingo.svg)](https://www.npmjs.com/package/milingo)

[![types](https://img.shields.io/npm/types/milingo.svg)](https://github.com/miare-ir/Milingo/blob/master/types/index.d.ts)

[![last commit](https://img.shields.io/github/last-commit/miare-ir/milingo.svg)](https://github.com/miare-ir/Milingo)

[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/Miare/Milingo)

# Miare Design Language (Milingo)

The Miare Design Language is a React component library with associated assets and styles available to use, as well as any other project you may choose to use this library with.

### Install Dependencies

 ```

 yarn install

 ```

### Building

This uses `webpack` to build:

```

yarn install

yarn dist

```

### Live Demo!

[here!](https://miare-ir.github.io/Milingo)

### Demo (storybook)

React Storybook is an easy way to develop components with real-time feedback, run in the browser. To run Storybook, just run:

```

yarn start

```

Then go to: http://localhost:9001/

### Usage

1. Import styles file in your main application file.

```

import 'milingo/dist/styles.css'

```

2. Enjoy!