https://github.com/movableink/fluid

A Design Framework for fluid & reactive interfaces
https://github.com/movableink/fluid

Last synced: 6 months ago
JSON representation

A Design Framework for fluid & reactive interfaces

• Host: GitHub
• URL: https://github.com/movableink/fluid
• Owner: movableink
• License: mit
• Created: 2022-01-14T19:17:13.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-25T20:08:34.000Z (over 1 year ago)
• Last Synced: 2024-04-15T12:29:04.455Z (about 1 year ago)
• Language: JavaScript
• Homepage: https://movableink.github.io/fluid
• Size: 19.8 MB
• Stars: 3
• Watchers: 22
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# fluid [![CI](https://github.com/movableink/fluid/actions/workflows/ci.yml/badge.svg)](https://github.com/movableink/fluid/actions/workflows/ci.yml) ![Percy](https://percy.io/static/images/percy-badge.svg) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

Fluid is [@movableink's](https://github.com/movableink) design system. We use a combination of emberjs, and tailwind to build our design system. The TailwindCss config docs can be found at [@movable/tailwind-config](https://movableink.github.io/tailwind-config)

## Installation

This currently is an `ember-addon` and should be installed as such:

```

ember install @movable/fluid

```

## Local Development

### Installation

1. Ensure you have [`volta`](https://volta.sh) installed on your computer

2. Clone the repo

3. `yarn install`

### Server

The documentation server can be run locally by running:

```sh

yarn storybook-dev

```

We use [Storybook](https://storybook.js.org/docs/react/get-started/introduction) for all our documenation. The local server is accessible via http://localhost:9001

### Testing

The tests can be run in an interactive browser

```sh

yarn test

```

## Conventional Commits

This repo has [conventional-commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) We lint for this both pre-commit and on PR actions. It is **required** and will not pass without it.

Ex:

```

fix(percy): added percy snapshots for all component states

- active

- disabled

- focused

```