@scgdigital/scg-ui-package v1.0.37-revision.35
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:
- Any newly created component should be directly exported out of
src/index.ts
file. - All components should aim to be dumb and minimalistic as possible and be styled through our defined
design system tokens
LINK. - 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:
- Lint Project, Remove unused dependencies. Carefully place dependencies in the right place (dependencies, devDependencies, peerDependencies)
- Attempt build locally until successfull build (
pnpm run build
). Optional: Create symlink of library withnpm link
and test library on other local project too. Update the
package.json
version following npmjs semantic versioning rules:
// Path: /package.json { "name": "@scgdigital/scg-ui-package", "version": "--.--.--", ... }
Code Status | Stage | Rule | Example Version |
---|---|---|---|
First Release | New Product | Start with 1.0.0 | 1.0.0 |
Backward compatible bug fixes | Patch Release | Increment the third digit | 1.0.1 |
Backward compatible new features | Minor Release | Increment the middle digit and reset the last digit to zero | 1.1.0 |
Changes that break backward compatibility | Major Release | Increment the first digit and reset the middle and last digits to zero | 2.0.0 |
- Finally, run
pnpm run publish
.
4 days ago
5 days ago
7 days ago
8 days ago
12 days ago
12 days ago
12 days ago
12 days ago
12 days ago
12 days ago
12 days ago
12 days ago
12 days ago
12 days ago
14 days ago
14 days ago
14 days ago
14 days ago
14 days ago
14 days ago
14 days ago
14 days ago
18 days ago
18 days ago
18 days ago
18 days ago
19 days ago
19 days ago
19 days ago
19 days ago
19 days ago
19 days ago
19 days ago
20 days ago
20 days ago
20 days ago
20 days ago
20 days ago
20 days ago
19 days ago
19 days ago
19 days ago
19 days ago
20 days ago
20 days ago
19 days ago
19 days ago
19 days ago
19 days ago
19 days ago
19 days ago
19 days ago
19 days ago
19 days ago
19 days ago
19 days ago
19 days ago
27 days ago
27 days ago
27 days ago
27 days ago
28 days ago
27 days ago
27 days ago
26 days ago
27 days ago
27 days ago
27 days ago
27 days ago
27 days ago
27 days ago
27 days ago
27 days ago
27 days ago
27 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago