Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AntonyZ89/vue3-boilerplate
VueJS 3 Boilerplate ( Vanilla / Nuxt 3 )
https://github.com/AntonyZ89/vue3-boilerplate
boilerplate form-validation i18n nuxt pinia tailwind tailwindcss tests typescript vuejs
Last synced: 8 days ago
JSON representation
VueJS 3 Boilerplate ( Vanilla / Nuxt 3 )
- Host: GitHub
- URL: https://github.com/AntonyZ89/vue3-boilerplate
- Owner: AntonyZ89
- Created: 2023-02-16T20:41:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-04-02T01:44:56.000Z (over 1 year ago)
- Last Synced: 2024-08-01T22:02:26.021Z (4 months ago)
- Topics: boilerplate, form-validation, i18n, nuxt, pinia, tailwind, tailwindcss, tests, typescript, vuejs
- Language: Vue
- Homepage:
- Size: 1.24 MB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VueJS Template 3
This template should help get you started developing with Vue 3 in Vite.
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [use TS Take Over mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669).
## 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/).
## Global Components
Declare all global components on `components.d.ts` and `Restart Vue Server`
( CTRL + ⇧ Shift + P or ⌘ + ⇧ Shift + P )
## Built with
- 
- 
- Pinia
- Vee-Validate + Yup
- Vue-i18n
- Vue-Router
- Eslint
- Prettier
- Vitest
- Husky
- Github Actions
- Tests workflows
## Prints 📷
Test coverage
## unit coverage (93%!)
## 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
```
### Lint with [ESLint](https://eslint.org/) and [Prettier](https://prettier.io)
```sh
npm run lint
npm run prettier
```
## Test
```bash
# unit tests
$ npm run test:watch
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Roadmap
- [x] i18n
- [x] router
- [x] form validation
- [x] pinia
- [x] Unit tests
- [x] Coverage 100% (93%)
- [x] husky
- [x] lint
- [x] unit test
- [ ] e2e tests
- [ ] Coverage 100% (??%)
- [x] Run tests on Pull Requests
- [x] PR template
- [ ] Server-side rendering
- [ ] SEO