This is a simple library of shared components for Pickle.

Getting Started

To install the package, run the following command:

npm install Next-Degree/pickle-shared-js

Steps to Publish

1. Update the Version Update the version in the package.json file. This should be done manually. Then run:

npm i

2. Bundle the Package To bundle the package, run:

npm run bundle

3. Verify the Contents of the Package To preview what will be published, run:

npm pack --dry-run

4. Open PR and Merge Open a PR and merge the changes to the MAIN branch.

5. Add a tag to the MAIN branch To add a tag to the repository, run:

git checkout main
git pull origin main  # Ensure your local branch is up to date
git tag -a v0.3.20 -m "Release version 0.3.20"
git push origin v0.3.20  # Push the tag to the remote

How to test the package locally

1. Push the changes to the repository in a new branch.

2. Save the name of the new branch.

3. Run the following command to install the package locally, replapcing [BRANCH-NAME] with the name of your branch:

npm install Next-Degree/pickle-shared-js#[BRANCH-NAME]