22 - Requirements to publish on NPM

[nozomione]

Issue Number

#22

Parent issue: #21

Purpose/Implementation Notes

Track the requirements to publish the package on NPM.

• Links to the resource docs to determine which approaches are most appropriate to keep in publish.md(specific to refinebio-js)

Types of changes

• Created a temporary directory docs to store the documentation files
  • e.g.) src/docs/requirements-to-publish.md

Functional tests

N/A

Checklist

• Lint and unit tests pass locally with my changes

Screenshots

N/A

Note

This is a 1st draft for the general instruction for publishing a npm package with Github Packages Registry(found to be a more robust approach than directly publishing the package to the npm Registry)

Benefits:

• Offers both public/private registries without the need of third party tools or paid services
• Offers the Github Actions without extra configurations as well as support other CI tools
• Offers built-in Package Analysis
• Supports a various registry protocols including the npm and the personal access token can be used for authentication
• Utilizes the Github global CDN for fast performance

Please see the GitHub Packages for more information. Thank you.

[nozomione]

(Update)

• Added the 1st draft for the General Requirement to publish npm packages with the Public npm Registry
  (*with no Github Packages)

  • src/docs/requirements-to-publish-with-public-npm-registry.md

• Updated the filename of the General Requirement to publish npm package with Github Packages

  • src/docs/requirements-to-publish-with-github-packages.md