@scgdigital/scg-ui-package v1.0.38-revision.20

Welcome to SCG-UI-PACKAGE

This project was built with the sole purpose of centralizing UI components for CU/Loans projects across the board.

Tech Stack: React + TS + Vite.

Installation

To install, clone repository, and then, you can use pnpm, npm or yarn for module installation. Node version: >=18

$ pnpm install

OR

$ yarn install

OR

$ npm install

Usage

While working with the package, some basic working guidelines:

1. Any newly created component should be directly exported out of src/index.ts file.
2. All components should aim to be dumb and minimalistic as possible and be styled through our defined design system tokens LINK.
3. Since we'd be using React, we'll be enforcing some design patterns:
   • Composition
   • SOLID principles
   • Preference over event-driven actions vs effects subscribed to state.
   • type safety for props and ability to extend native semantic element props to components.
   • Every component should be accompanied by a unit test.

To start the project in development, run:

$ <pnpm/npm> run dev
or
$ yarn dev

Package - updates and versioning

To issue new updates to the package, follow these steps:

1. Lint Project, Remove unused dependencies. Carefully place dependencies in the right place (dependencies, devDependencies, peerDependencies)
2. Attempt build locally until successfull build (pnpm run build). Optional: Create symlink of library with npm link and test library on other local project too.

3. Update the package.json version following npmjs semantic versioning rules:

// Path: /package.json
{
"name": "@scgdigital/scg-ui-package",
"version": "--.--.--",
...
}

4. Finally, run pnpm run publish.