jgl_hanzo-ui-core v1.0.8
Hanzo UI Core Setup
Hanzo-ui-core is a headless UI library for React applications. It provides a set of reusable and customizable components that can be easily integrated into any React project. Based in design system UICore Design System Template
Requirements
Installation
This repository serves as the base to start the UI of a React based project. It can be used through npm. Need to install the proper version in your project.
npm / yarn
npm install @hanzo/hanzo-ui-core # yarn add @hanzo/hanzo-ui-core@[version]Webpack
You can also add Hanzo-ui-core as a dependency in your package.json file and then run npm install or yarn install:
{
"dependencies": {
"hanzo-ui-core": "^1.0.0"
}
}Updates/new features
To develop Hanzo-ui-core, you must have Node.js version 18.14.2 or higher installed on your machine. You can clone the repository from GitHub and then run npm install or yarn install to install the dependencies:
When the new feature is developed, you need to update the version inside the package.json and publish using npm. Before publish need to create an auth token.
Publish new version and use it in your project
- Login in npm with npm username and password.
npm login- If you have two-factor authentication enabled, when prompted, enter a one-time password.
- Test you are authenticated.
npm whoami- Create token. TOKEN
- Authenticate to the Package Registry If you would like to install a package from a private project, you would have to authenticate to the Package Registry. Skip this step if the project is not private.
npm config set -- //repos.codehanzo.com/api/v4/projects/376/packages/npm/:_authToken="${TOKEN}"- Set the registry
npm config set @hanzo:registry https://repos.codehanzo.com/api/v4/projects/376/packages/npm/- Install the package
yarn add @hanzo/hanzo-ui-core@1.0.8Linting
To maintain clean and consistent code, Hanzo-ui-core uses eslint and prettier. You can run linting on your code using the following command:
npm run lint # or yarn lint