@onerecord/web-components NPM

OneRecord Web Components

This is a library of Web Components for the OneRecord organization.

Local Development

Use the correct node version (see .nvmrc file for which version).

Install dependencies with pnpm install. Install in root directory and in solid-web-components/ Run pnpm start to start up the development server.

Using the Web Components.

The components written in SolidJS are registered when dist/v2/<component> is imported.
Legacy components written in StencilJS should be defined via the defineCustomElements method.

Manual Testing

You may use yalc to manually test changes before publishing. The process is similar to publishing.

Make your changes
pnpm run build
Run yalc publish from the root directory. Now you may use yalc add to consume and test your changes in other projects.

Building the project and publishing to NPM

Make sure the version number in package.json is incremented, merged into develop, merged into main and a release branch created
git tag <version number>
git push origin tag <version number>
pnpm install
pnpm build
Make sure you have an NPM auth token configured in either your global .npmrc or project specific .npmrc and then run npm login
npm publish