@zedelivery/mozeic-web-design-system

mozeic-web design-system

Zé Delivery Design System for Web

Prerequisites !

• Node.js v14.x+ installed
• NPM v5.2+ installed

Installing

In order to install Mozeic-web you need two main things:

yarn add @zedelivery/mozeic-web-design-system
# or
npm install @zedelivery/mozeic-web-design-system

To note

Mozeic-web uses emotion/react as peer dependency, so in order to properly install the project run:

yarn add @emotion/react
# or
npm i @emotion/react

Usage

import { Button } from '@zedelivery/mozeic-web-design-system'

<Button>Submit</Button>

Development workflow

Installing

Once you've cloned this repository, navigate to the project folder. Run the following command:

npm install

Developing

Also, we use storybook to build our UI components in a controlled environment. To start, run:

npm run storybook

Testing

We use jest and react testing library to test our components. To test, runL

npm run test
# or
npm run test: watch

Committing

We follow an automated release process using sematic-release to follow SEMVER protocols. So to commit run:

npm run commit

This command will open a prompt, where you can choose some items:

• type of change
• scope of change
• write a short message
• write a long message
• link a repo issue

After setup your commit message, before finish we run some pre-validations and then push to the origin remote.

To read more about some of these tools:

• semver
• karma commit message guideline
• semantic release