# Flow

> ## ⚠️ This is a legacy version of Flow UI library and is no longer maintained. Please use [Flow 2](https://github.com/cldcvr/flow-core) for future projects.

Flow is a lightweight UI component library based on Vue. It uses StorybookJS as showcase app and sandbox to build components in isolation.

## Table of contents

- [Prerequisites](#prerequisites)
- [Technologies](#technologies)
- [Local Setup](#local-setup)
- [Usage](#usage)

## Prerequisites

To use the Flow library, you should be familiar with the following:

### Node.js

Flow requires node version 16+.<br/>
For more information on installing Node.js, see [nodejs.org](https://nodejs.org/en/). If you are unsure what version of Node.js runs on your system, run node -v in a terminal window.

### Vue.js

Vue is a progressive framework for building user interfaces. For more information , see [vuejs.org](https://vuejs.org/)

## Technologies

Project is created with:

- **Vue: 2.6.+**
- **Storybook: 6.0.+**
- **SASS: 1.26.+**

## Local Setup

To run flow library locally, Go to root folder of flow and run following command:

1. Using yarn

```bash
yarn && yarn start
```

## Usage

This guide explains how to setup your Vue project to begin using Flow library.Your Vue.js project must be on version 2.6.\*.

1. Install via yarn

```bash
yarn add @cldcvr/flow
```

1. Import Flow CSS in your codebase

```js
import "@cldcvr/flow/dist/style.css";
```

1. Import Component in your Vue file like below

```js
import { Icon, Button, Pictogram } from "@cldcvr/flow";
```

## Support

We have a [Slack channel](https://cldcvr.slack.com/archives/C022UUMF18V) where you can check for announcements and raise questions.
