An open API service indexing awesome lists of open source software.

https://github.com/lorefnon/vue3-spa-starter


https://github.com/lorefnon/vue3-spa-starter

Last synced: 9 months ago
JSON representation

Awesome Lists containing this project

README

          

# Opinionated Vue 3 SPA starter

Personal base/starter project for client-side SPAs powered by Vue3.

- Vue 3 [setup script](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup)
- Filesystem routing with vue-router and unplugin-vue-router
- Tabler icons
- Naive UI
- Pinia for state management
- Pug syntax templates
- Sass for styling

## Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).

## 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)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) 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](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) 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.