Skip to content

dogezhou/vue3-demo

Repository files navigation

vue3-demo (Vite + Vue3 + Typescript starter)

CI codecov

简体中文

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:

npm install -g yarn

Getting started

  • Clone the repository
git clone https://github.com/dogezhou/vue3-demo.git
  • Install dependencies
cd <project_name>
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

  • Add sass support
  • Add lint and run linter at pre-commit
  • Add unit test with jest
  • Add unit test coverage with jest
  • Add github actions for CI and unit test coverage