Mbbr-2020-design-system

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 <script setup> SFCs, check out the script setup docs to learn more.

Recommended IDE Setup

• VS Code + 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.

Informations

The app use:

1. Vue 3
2. Ts
3. Vite
4. Storybook
5. Jest
6. Quasar
7. Prettier
8. Lint
9. Husky

Important commands

• "npm run dev" to run app
• "npm run build" to build app
• "npm run storybook" to view Design System
• "npm run build-storybook" to build Design System
• "npm run lint:fix" to check and fix code errors
• "npm run format" to format code
• "npm run test" to run tests with jest

To publish package

1. add this line in package.json

• "types": "./dist/main.d.ts"

2. npm run build
3. set github token in your system variables

• MAC OS
• export GITHUBTOKEN="YOUR_TOKEN"
• echo $GITHUBTOKEN

4. npm publish
5. Remove types line of package.json

To install

• npm install @corporate/mbbr-2020-design-system@latest