This starter template built for Pointhub project to create frontend apps more easily, along with some good practices that I have learned. It's strongly opinionated, but feel free to tweak it to your needs.
VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).
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:
- Disable the built-in TypeScript Extension
- Run
Extensions: Show Built-in Extensions
from VSCode's command palette - Find
TypeScript and JavaScript Language Features
, right click and selectDisable (Workspace)
- Run
- Reload the VSCode window by running
Developer: Reload Window
from the command palette.
See Vite Configuration Reference.
- Vite Next Generation Frontend Tooling
- TypeScript is a strongly typed programming language that builds on JavaScript
- Vitest Unit Test Framework.
- Cypress E2E Testing
- ESLint Code Linting
- Prettier Code Formatting
- Tailwind CSS v3 - Rapidly build modern websites without ever leaving your HTML
- Node.js v16.x or higher
- pnpm creates a non-flat node_modules by default, so code has no access to arbitrary packages
npm install -g pnpm
pnpm install
pnpm dev
pnpm build
Run Unit Tests with Vitest
pnpm test:unit
Run End-to-End Tests with Cypress
pnpm build
pnpm test:e2e # or `pnpm test:e2e:ci` for headless testing
Lint with ESLint
pnpm lint
Go to Netlify and select your repository, OK
along the way, and your App will be live in a minute.