@gocartpay/web-lib v1.0.71

web-lib

Component Library for Skipify's UI

About The Project

Component library based on MUI

Please note, you will need to be on node 16+ to use precommit hooks.

Built With

• React
• MUI
• Jest
• Babel
• Typescript
• Rollup
• Storybook

Getting Started

To get a local copy up and running follow these simple example steps.

1. Clone the repo

   git clone git@github.com:GoCartPay/web-lib.git

2. Install NPM packages

   npm install

3. Explore the docs

   npm run storybook

4. Make some changes
5. Build the library

   npm run build

6. Commit the changes (including the dist folder)

   git add --all
   git commit -m "Detailed commit message"

7. Push back up to repo

   git push

Usage

This is a library, meant to be used within other applications.

1. Install the package

   npm i GoCartPay/web-lib

2. Use the components

   import Button from @gocartpay/web-lib

Contact

Simon Willems - simon.willems@skipify.com