promo-design-system v1.2.25

✨ Features

• 🌈 Enterprise-class UI designed for web applications.
• 📦 A set of high-quality React components out of the box.
• 🛡 Written in TypeScript with predictable static types.
• ⚙️ Whole package of design resources and development tools.

🖥 Environment Support

• Modern browsers

📦 Install

npm install @augkamil/promo-design-system

yarn add @augkamil/promo-design-system

🔨 Usage

import { Button } from '@augkamil/promo-design-system';

const App = () => (
  <>
    <Button type="primary">PRESS ME</Button>
  </>
);

🔎 Testing

Each Promo Design System component should contain both unit tests written with [Jest] and E2E tests written with [Cypress]. This project has scripts which are prepared for running each one of them. CI is also configured to trigger tests before building next version of app.

Jest

$ npm run test-unit

Cypress

$ npm run test-e2e

TypeScript

Promo Design System is written in TypeScript with complete definitions.

🧳 Versioning

Promo Design System is using [Conventional Commits] for automated versioning of the library.

⌨️ Development

Install as package (first ask for adding to package as contributor) [Promo.com Design System]

Or clone locally:

$ git clone git@gitlab.int.promo.com:promo/promo-design-system.git
$ npm install
$ npm run storybook

Open your browser and visit http://localhost:6006 (it should happen automatically after finishing the build of storybook).