battoni / world-groccer

World Groccer

Important links

• Live Preview

• Storybook

• Doccumentation

• About me

• Architecture

• How to use

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.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Hot-Reload development

Development

npm run dev

Storybook with Histoire

npm run story:dev

Docs with VitePress

npm run docs:dev

Unit Tests with Vitest

npm run test:unit --watch

Linters

Lint with ESLint

npm run lint

Format with Prettier

npm run format

For production

Type-Check, Compile and Minify for Production

npm run build

Compile stories for productions

npm run story:build

Compile docs for production

npm run docs:build

See package.json scripts section for more.