template-qwik-package

Opinionated Qwik template for new component packages.

• Source code
• npm package
• Licenses

Getting Started

1. Go to or create the package folder.
2. Get the template files:

npx degit github:joaopalmeiro/template-qwik-package

or

npx degit github:joaopalmeiro/template-qwik-package --force

3. Search for template-qwik-package and replace it with the package name.
4. Search for Opinionated Qwik template for new component packages./Opinionated [Qwik](https://qwik.dev/) template for new component packages. and replace it with the (short) package description.
5. Search for João Palmeiro and replace it with the author's name.
6. Install fnm (if necessary).
7. Run the first two commands in the Development section to install Node.js and the development dependencies.
8. Open the NOTES.md file and install the package-specific dependencies according to the first command in the Commands section.
9. Update the Source code link at the top to the package repository link.
10. Change GitHub in the Deployment section to GitLab or Codeberg (if necessary) and update the link to the corresponding Tags page.
11. Delete the Template References section from the NOTES.md file.
12. Delete the Getting Started section.

Development

Install fnm (if necessary).

fnm install && fnm use && node --version && npm --version

npm install

npm run format

npm run lint

npm run dev

npm run build

Deployment

Package

npm pack --dry-run

npm version patch

npm version minor

npm version major

• Update the version in the Licenses link at the top.
• Commit and push changes.
• Create a tag on GitHub Desktop.
• Check GitHub.

npm login

npm publish

• Check npm.