21.9.1 • Published 6 months ago
publishtocustom v21.9.1
CTI UI KIT
This repository contains basic react UI components, hooks and utils for CTI technology front-end projects.
Figma | Storybook | Confluence
Read Installation guide to install and setup project to front-end app
Local development
Requirements
- pnpm installed (npm install -g pnpm) (^9.x.x)
- Node 20.x.x or higher
Branching strategy
- From main create feature branch with name in format:
type/scope
Examples:fix/CP-123
,feat/TB-123
,fix/issue-123
- Create PR to main branch
- For deploy and release follow release strategy
Standalone local development in storybook
Simply run pnpm install
and pnpm dev
to start storybook locally
Local development with package linking
Supposing that you have following folder structure:
$ ls
# Shows up folders /cti-ui /tb_front
- Run
pnpm build:watch
on ui kit folder - Change the entry for ui kit in
package.json
to"@cti-technology/cti-ui-kit": "file:../cti-ui-kit/"
. Note: we are usingfile:
protocol because it better resolves the peer dependencies from the project dependencies, ensuring that the linked dependency correctly uses the versions of the dependencies specified in your main project, leading to more consistent and expected behaviors - Run
pnpm i
andpnpm run dev:ui-kit
in tb_front folder. Note: you will have to runpnpm i
every time the ui-kit is rebuilt - After you finished your work rollback the entry in
package.json
Read more about linking in pnpm
Commands
- Local Development:
pnpm dev
- Build:
pnpm build
- Test:
pnpm test
- Re-build on file change::
pnpm build:watch
Deployment
See complete list of steps for deployment build in Dockerfile
Testing and Linting
- Type Errors Check:
pnpm typecheck
- Linting and Formatting:
pnpm lint:fix
- Lint Checking:
pnpm lint
- CI/CD lint check:
pnpm lint:check
- CI/CD lint check:
- Unit Testing:
- Watch Mode:
pnpm test
- Run Once:
pnpm test:once
- Test Coverage Report:
pnpm coverage
- UI View of Test Coverage:
pnpm test:ui
- Watch Mode:
Corporate Tax Incentives Home page | Twitter @cti_llc | Jobs
21.9.1
6 months ago