boopathi / atomic

Framework to build atomic design CSS libraries in a functional manner.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status

Atomic

A Framework to build atomic design CSS libraries in a functional manner.

Installation

$ yarn install -g @utilitycss/atomic

Usage

Atomic is meant to be used on monorepos, using yarn workspaces and lerna to handle internal dependencies. Your project should also live under a single npm scope (e.g. @my-design-sytem/package-name).

If you installed atomic globally you can bootstrap a new atomic project using

$ mkdir my-project && cd my-project
$ atomic init

Alternatively you can use npx

$ mkdir my-project && cd my-project
$ npx @utilitycss/atomic init

To build the CSS bundle use

$ yarn build

To start the watch mode use

$ yarn start

If you already built the project once and you only want to watch for changes you can use the --no-rebuild (-n) flag

$ yarn start -- -n

About

Framework to build atomic design CSS libraries in a functional manner.


Languages

Language:TypeScript 73.6%Language:JavaScript 15.5%Language:HTML 10.8%