create-permawidget-vue

VueJS Widget Template

This template should help get you started developing a Permapage Widget with Vue 3 in Vite.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

1. Change the informations of the project in package.json.
2. Change the id of the widget in src/main.ts and index.html.

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

Note: This will also generate a dist folder with the compiled widget. Note: Your CSS is inside dist/widget.js.

npm run build

Lint with ESLint

npm run lint

Deploy to Permapages

Note: You need to update your package.json, index.html and src/main.ts with your own information.

npm run build

npm run deploy <path to your JWT>