https://github.com/logitar/vue3template
Vue3 template with TypeScript, Pinia, router, i18n, Bootstrap, Font Awesome and validation
https://github.com/logitar/vue3template
bootstrap5 fontawesome6 i18n pinia typescript veevalidate vue3 vuerouter4
Last synced: 30 days ago
JSON representation
Vue3 template with TypeScript, Pinia, router, i18n, Bootstrap, Font Awesome and validation
- Host: GitHub
- URL: https://github.com/logitar/vue3template
- Owner: Logitar
- License: mit
- Created: 2023-06-05T00:57:37.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T17:48:56.000Z (about 1 year ago)
- Last Synced: 2025-02-08T02:43:04.844Z (3 months ago)
- Topics: bootstrap5, fontawesome6, i18n, pinia, typescript, veevalidate, vue3, vuerouter4
- Language: Vue
- Homepage:
- Size: 749 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Logitar Vue3 Template
This template should help get you started developing with Vue 3 in Vite. It integrates TypeScript, Pinia stores, routing, i18n, Bootstrap, Font Awesome, forms and validation, and unit tests using Vitest.
## Recommended IDE Setup
[VSCode](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.
## Customize configuration
See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup
```sh
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Type-Check, Compile and Minify for Production
```sh
npm run build
```
### Preview the Last Build from dist
```sh
npm run preview
```
### Run Unit Tests and Code Coverage with [Vitest](https://vitest.dev/)
```sh
npm run test
```
### Run Unit Tests with Vitest
```sh
npm run test:dev
```
### Build the Application Without Type Checking for Production
```sh
npm run build-only
```
### Type Check the Application Code Without Building
```sh
npm run type-check
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```
### Format with [Prettier](https://prettier.io/)
```sh
npm run format
```