@paystack/pax

A React UI Library for the PAX Design System

🧐 Prerequisites

• Node >= 22
• NPM

📦 Installation

npm install @paystack/pax

🏎 Quick start

Follow the following steps to setup the project for local development:

• Clone the project

  git clone https://github.com/PaystackHQ/pax.git
  

• Install dependencies

  npm install
  

• Launch Storybook

  npm run storybook
  

• Run tests

  npm run test
  

To create a new component, run npm run new:component and you will be prompted for a component name and an optional path (relative to /src/components) if the component requires a custom location.

Answering both questions will create the following directory structure with basic boilerplate in the generated files.

[component_name]
 ┣ [component_name].stories.tsx
 ┣ [component_name].test.tsx
 ┗ index.tsx

📨 Commits

Versions are automatically managed by semantic-release which relies on commit messages to determine how to bump version numbers; features bump to a major semver version while fixes bump to a minor version.

This library uses Commitizen to enforce commit message styles so this hijacks your normal commit flow and instead guides you through prompts on the command line.

📦 Releases

PAX is automatically packaged and published to npm from the external branch.

💙 Contributing

Interested in contributing? Thanks so much for your interest! If you have a bug to report, or maybe an improvement, please check out our Jira Board.