dev.md

back

👩‍💻 Develop & contribute

Setup

Checkout the project and install its dependencies:

git clone git@github.com:puzzle/puzzle-shell.git
cd puzzle-shell
nvm use
npm install

Tryout Components with Storybook

To run a local instance of Storybook, run:

npm run storybook

To build a production version of Storybook, run:

npm run build-storybook

Linting etc.

To scan the project for linting or type errors, run:

npm run lint

To automatically fix many linting errors & reformat code using Prettier, run:

npm run lint:fix

To automatically generate the custom-elements.json manifest using the web-component-analyzer, run:

npm run manifest

Publishing

To publish a new package version, do the following:

• Build the library with npm run build
• Execute npm run manifest to make sure the custom-elements.json manifest is up-to-date
• Update the CHANGELOG.md
• Bump the version with npm version (updates package.json and creates Git tag)
• Execute npm publish to upload the new package version