https://github.com/dogezhou/vue3-demo

This project is a Vue3 + :zap: Vite + TypeScript starter. Clone it and Use it as your project starter. :gift_heart:
https://github.com/dogezhou/vue3-demo

ci codecov coverage github-actions jest linter pre-commit prettier typescript unit-testing vite vue3 yarn

Last synced: 1 day ago
JSON representation

This project is a Vue3 + :zap: Vite + TypeScript starter. Clone it and Use it as your project starter. :gift_heart:

• Host: GitHub
• URL: https://github.com/dogezhou/vue3-demo
• Owner: dogezhou
• Created: 2020-09-28T10:14:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-16T07:49:30.000Z (about 4 years ago)
• Last Synced: 2024-11-11T18:09:20.638Z (2 months ago)
• Topics: ci, codecov, coverage, github-actions, jest, linter, pre-commit, prettier, typescript, unit-testing, vite, vue3, yarn
• Language: JavaScript
• Homepage:
• Size: 147 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vue3-demo (Vite + Vue3 + Typescript starter)

[ ![CI](https://github.com/dogezhou/vue3-demo/workflows/CI/badge.svg)](https://github.com/dogezhou/vue3-demo/actions?query=workflow%3ACI)

[![codecov](https://codecov.io/gh/dogezhou/vue3-demo/branch/master/graph/badge.svg?token=RKXRX99XPE)](https://codecov.io/gh/dogezhou/vue3-demo)

[简体中文](docs/README_zh.md)

The main purpose of this repository is to show a working Vite + Vue3 + Typescript project.

You can use it as a project starter

## Pre-reqs

To build and run this app locally you will need a few things:

- install [Node.js](https://nodejs.org/en/)

- install yarn

```

npm install -g yarn

```

## Getting started

- Clone the repository

```

git clone https://github.com/dogezhou/vue3-demo.git

```

- Install dependencies

```

cd 

yarn

```

- Compiles and hot-reloads for development

```

yarn dev

```

- Compiles and minifies for production

```

yarn build

```

## Contributing

I appreciate all suggestions or PRs which will help build a more convenient Vue3 project starter. 

Feel free to fork the project and create a pull request with your idea.

## TODO

- [x] Add sass support

- [x] Add lint and run linter at pre-commit

- [x] Add unit test with jest

- [x] Add unit test coverage with jest

- [x] Add github actions for CI and unit test coverage