carelynx-react-components

Create a new component

Refer: https://www.npmjs.com/package/create-react-library to generate a new component. Once the new component is created follow the instructions below:

• Replace the package.json content in the newly created component folder with the content from example-package.json in the root folder.
• Delete .eslintrc, .editorconfig, .eslintignore, .gitignore, .prettierrc, .travis.yml from the component folder as some of these files are already present in the root path.
• Rename the index.js and index.test.js file in the src folder .jsx.

Start a server for a given component

Run ./start.sh from the root folder

NOTE: The shell script will ask you to enter the component folder for which the server has to be run. If this fails you can manually spin up the server by running the commands below from the root:

- In one tab, run `cd carelynx-component-name && yarn start`
- And in another tab, run `cd carelynx-component-name/example && yarn start`

Run tests

Run the ./tests.sh from the root folder

NOTE: The shell script will tests for all the components. If you want to run test for a single component then `cd {component_folder}` and then run `yarn test`.

Publishing a component

You can set a release candidate version by running the command below

npm version prerelease --preid=rc --no-git-tag-version

You need to log into the Carelynx NPM account before you can publish the package

npm login

Publishing

yarn publish

This will guide you through the publishing process. Once published you can cross-check the package in the Carelynx NPM packages dashboard