bencodezen / vue-enterprise-boilerplate

An ever-evolving, very opinionated architecture and dev environment for new Vue SPA projects using Vue CLI.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Vue Enterprise Boilerplate v3 (alpha)

This repo is currently in active development and considered in alpha release.

This is an ever-evolving, opinionated architecture and dev environment for new Vue 3 + Vite SPA projects using create-vue.

🎩 A huge thanks to Chris Fritz for the incredible work that this work builds upon. For those looking for his version, see this branch for the original Vue 2 enterprise boilerplate.

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.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Run End-to-End Tests with Playwright

# Install browsers for the first run
npx playwright install

# When testing on CI, must build the project first
npm run build

# Runs the end-to-end tests
npm run test:e2e
# Runs the tests only on Chromium
npm run test:e2e -- --project=chromium
# Runs the tests of a specific file
npm run test:e2e -- tests/example.spec.ts
# Runs the tests in debug mode
npm run test:e2e -- --debug

Lint with ESLint

npm run lint

About

An ever-evolving, very opinionated architecture and dev environment for new Vue SPA projects using Vue CLI.

License:MIT License


Languages

Language:Vue 59.3%Language:TypeScript 25.8%Language:CSS 11.7%Language:HTML 1.6%Language:JavaScript 1.6%