@strategicimpact/shero-common

npm package @strategicimpact/shero-common

This is a library of common UI components created for shero apps development.

Getting Started

Package installation

Use the package manager npm to install it.

npm i @strategicimpact/shero-common

Development of features

At the beginning you need to install all dependencies by running the following command:

npm install

Development happens in feature branches in the form of PRs.

Entry Points

Be aware of using correct paths in main field of package.json file - this is an entry point for storybook application and library.

Before publishing your changes you should be sure that you set up a main field as an entry point for library:

"main": "./dist/index.js"

To run storybook you have to change main path in the package.json file to an entry point for expo app.

  "main": "node_modules/expo/AppEntry.js"

Versioning

Remember to increase version of the library in package.json file before pushing your changes. Otherwise the publish process is going to fail.

  "version": "1.1.0" ===> "version": "1.1.1"

Publishing

Publishing is an automatic action which happens after merging your code.

If you need to publish changes directly, you can do this by command line. First, you need to have access to publishing changes to the package given by administrator. Next you need to be logged in to npm on your machine. If not - run command:

  npm login

Next it's time to build the package to dist folder by running:

  npm run build

Now you are ready to publish changes from dist folder to npm package by running:

  npm publish

Testing

Before pushing your code you should make sure that the application is still passing all tests by executing the following command:

npm run test

In case you need to update local snapshots run the command below. Always check that the changes are reasonable and as expected.

npm run test -- -u

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.