Seanitzel/Quasar-V2-Storybook

Quasar2 Storybook Boilerplate

Quasar2 Storybook Boilerplate https://quasar2-storybook-boilerplate-5ppdanscg-badsaarow.vercel.app/

Prerequisition

• node 14, npm, android studio, xcode
• For windows, set script-shell to pwsh or git bash

npm config set script-shell pwsh --userconfig ~/.npmrc

sudo npm install -g yarn cordova @quasar/cli @quasar/icongenie
yarn
cd src-cordova
cordova requirements

auth snyk

• Checking licence requires snyk login

node_modules/.bin/snyk auth

Start the app in development mode (hot-code reloading, error reporting, etc.)

yarn run dev:browser
yarn run dev:android
yarn run dev:ios

storybook

yarn run dev:storybook
yarn run build:storybook

Lint the files

yarn run lint

Unit Test

yarn run test:unit:ci

E2E Test

yarn run test:e2e:ci

Audit

yarn run audit:snyk
yarn run audit:node_modules
yarn run audit:licenses
yarn run audit:lighthouse

• yarn run audit:snyk needs running ./node_modules/.bin/snyk auth first

Build the app for production

yarn run build:android
yarn run build:ios

key signing - Change to your keystore

jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore <your-release-key.keystore> \dist\cordova\android\apk\release\android-debug.apk alias_name

Documents

• ADR : doc/architecture/decisions

Cautions

• DO NOT Upgrate to webpack5 : quasar does not support webpack5 yet

Troubleshooting

• TLS error while yarn set NODE_TLS_REJECT_UNAUTHORIZED=0, $env:NODE_TLS_REJECT_UNAUTHORIZED=0

• yarn run audit:snyk failed with exit code 2

  • check with debug log

  yarn run audit:snyk --debug
  ...
  "error-message": "`snyk` requires an authenticated account. Please run `snyk auth` and try again."

  • Do snyk auth first.