components

Nuwe componenets libray poweered by MaterialUI, Nivo and other cool Libraries

Install

Clone the repo

git clone https://github.com/nuwe-io/components

Install dependencies

npm install

Working with branches and gitflow

   git branch [branch_name]
   git checkout [branch_name]

Push to branch

    git add .
    git commit -m "Title" -m "Description"
    git push origin [branch_name]

Usage

import { Button } from "@nuwe/components";

const MyComponent = () => {
  return <Button>Text</Button>;
};

• Running locally:

    npm run storybook

To run the unit tests:

    npm run test #Not yet configured

Deploy & public to NPM & Chromatic

CD/CI setup with vercel

Deplopy and managed with storybook & chromatic

https://github.com/portexe/react-pwr

1 Publish and check with chromatic

• For publishing the library to chromatic:

    npm run chromatic # Publish Storybook and run visual tests

2 Update npm package

Checkout to the MAIN branch and modify the version of the package version

Build with rollup:

    npm run build-lib

After that login and push to npm

    npm login

    npm publish --access public

Push to the branch

git add .
git commit --m "RELEASE VERSION X.X.X"
git push --origin main

This will automtically trigger vercel

Build

There maybe apear some build errors (rollup import configs mainly).

If that happens, go to: rollup.config.js and add the import creating the error:

// rollup.config.js
export default [{
    ...,
    plugins: [
    ...,
    commonjs({
         namedExports: {
             'library-name':["Export1","Export2"]
         }
    })
    ]
}]

Contact info

You can get in touch via:

Edgar Gago Carrillo Add Contributor name here

or

Edgar Gago | [email protected]

Licence

MIT