Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fazulk/vue3-ts-boilerplate

Vue3 boilerplate with storybook, unit testing, generators, typescript, pinia, vue-router
https://github.com/fazulk/vue3-ts-boilerplate

storybook typescript unit-tests vite vuejs

Last synced: 30 days ago
JSON representation

Vue3 boilerplate with storybook, unit testing, generators, typescript, pinia, vue-router

Awesome Lists containing this project

README

        

# 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
- vue-router
- eslint
- prettier
- storybook
- unit tests/code cov (vitest & testing library)
- generators (plop)

testing & storybook examples: `src/components/examples`

## Project Setup

use yarn
node 16

```sh
yarn
```

## Compile and Hot-Reload for Development

```sh
yarn dev
```

## Type-Check, Compile and Minify for Production

```sh
yarn build
```

## Deploy

```sh
.. coming soon ..
```

## Storybook

With interaction testing

```sh
yarn storybook
```

## Unit Tests

Using Vitest

```sh
yarn test
```

## Generate new files

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

```sh
yarn generate
```