Skip to content
This repository has been archived by the owner on Sep 4, 2024. It is now read-only.

Novatics/novatics-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NOVATICS UI

NOVATICS UI contains simple and complex React components, is based on Material UI

Installation

Novatics UI

Install Novatics UI, it is available as an npm package

npm:

npm install @novatics-ui/core

yarn:

yarn add @novatics-ui/core

Getting started with Novatics UI

Check our documentation

Here is an example of a basic app using Novatics UI's CurrencyTextField component:

import * as React from 'react';
import CurrencyTextField from '@novatics-ui/currency-text-field';

function App() {
  return (
    <CurrencyTextField
      value={123456}
      onChange={() => {
        /* setup on change */
      }}
    />
  );
}

In this playground, try changing the props and see how it affects the output and the code.

Contributing

Developing

  1. Download the project and install dependencies
yarn install
  1. Use nx generators to create the component and the storybook documentation. Visit the Nx Documentation to learn more.
yarn component:generate
  1. Run the storybook to start developing
yarn dev
  1. Sign-up all commits, Here is How to Sign using gpg, ssh or S/MIME

  2. Create a Pull request and wait for approval.

Local Publishing on Docker

Deploy Verdaccio on local Docker

yarn verdaccio:up

Add user to verdaccio

yarn verdaccio:addUser

note On linux, there may be a permission error, in this case it is necessary to give permission on the sudo folder.

sudo chown 10001:65533 -R storage

Create versions, push to git and deploy.

yarn versions:create:push:deploy

License

This project is licensed under the terms of the MIT license.