Skip to content

dallington/vue3-ts-start

Repository files navigation

WORK IN PROGRESS

Vue3 TS Boilerplate (slim)

The goal of this project is to effectively add minimal dependencies that actually work for the vue/ts/vite ecosystem. No insane animation libraries here!

  • vue3
  • typescript
  • pinia for state mgmt
  • windicss
  • vue-router (generate routes automatically)
  • eslint
  • prettier
  • storybook
  • unit tests/code cov (vitest & testing library)
  • generators (plop)
  • commitlint
  • commitizen
  • husky

testing & storybook examples: src/components/examples

Folder Structure

src/
  ├── components/
  │   ├── comming soon
  ├── layouts/
  ├── router/
  ├── store/
  └── views/

Project Setup

use npm/yarn node 16

npm
yarn

Compile and Hot-Reload for Development

npm run dev
yarn dev

Type-Check, Compile and Minify for Production

npm run build
yarn build

Deploy

.. coming soon ..

Storybook

With interaction testing

npm run storybook
yarn storybook

Unit Tests

Using Vitest

npm run test
yarn test

Generate new files

Create new Components/Layouts/Views/Stores
By default adds a unit test and includes option to add story.

npm run generate
yarn generate

Commit

Interactive bash to commit using commitlint rules

npm run commit
yarn commit