Vue Masteclass

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 <script setup> SFCs, check out the script setup docs to learn more.

Recommended IDE Setup

• VS Code + Volar

Type Support For .vue Imports in TS

Since TypeScript cannot handle type information for .vue imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in .vue imports (for example to get props validation when using manual h(...) calls), you can enable Volar's Take Over mode by following these steps:

1. Run Extensions: Show Built-in Extensions from VS Code's command palette, look for TypeScript and JavaScript Language Features, then right click and select Disable (Workspace). By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
2. Reload the VS Code window by running Developer: Reload Window from the command palette.

You can learn more about Take Over mode here.

Technologies

• JS framework - Vue
• Frontend tooling (builder) - Vite
• Frontend workshop - Storybook
• Linting
  • ESLint
  • ESLint-plugin-vue
  • TypeScript ESLint
• Programming language - TypeScript
• Routing - Vue Router
• State management - Pinia
• Styling language - Sass
• Test suite - Cypress

Getting Started

Since package-lock.json is included in the repo, we want to avoid overriding it with npm i. Instead we run npm ci:

Run npm ci to install dependencies.

Run this command any time package.json changes.

Commands

Run npm run dev to start development server.

Run npm run storybook to start design system server.

Run npm test to open the testing suite (Cypress).