@wanderingleaf/learning-pc-web-components v1.0.18

# This is only for studying. Nothing in it. Please do not download.

Basic Components Library & Storybook User Guide

Basic Components is a React library that can be published to NPM. If you’re looking to build a React-based app, you should use create-react-app, razzle, nextjs, gatsby, or react-static.

Commands

Start storybook

yarn storybook

Build library, output files are under lib folder.

yarn build

Build storybook, output files are under storybook-static folder.

build-storybook

Check code patterns, please run eslint before any commit.

yarn lint

Unit tests, please run Jest tests before any commit.

yarn test or yarn test:watch

Components stories

Components stories are under stories folder.

Publishing to NPM

login to npm

npm login

publish

npm publish --access public

Publishing to AWS CodeArtifact

config aws

aws codeartifact login --tool npm --repository learning-packages --domain learning-domain --domain-owner 750000000017 --region eu-west-2

publish

yarn publish

Yarn install from AWS CodeArtifact

set to install from AWS CodeArtifact

aws codeartifact login --tool npm --domain learning-domain --domain-owner 750000000017 --repository learning-packages

Changing back to the default npm registry

npm config set registry https://registry.npmjs.com/

How to use it?

Should install it as node modules as other libraries. It's suggested to always use the latest version.

How to develop components locally?

• Make component changes in src folder.
• Run yarn build to generate new js buildle.
• Replace node module buildles under node_modules with the new files.

Rollup

Uses Rollup as a bundler.

TypeScript

tsconfig.build.json is set up to interpret dom and esnext types, as well as react for jsx.