vite-vue2-starter/README.md

<h1 align="center">Vite ⚡ - Vue 2 starter template</h1>

<p align="center">
  Create a Vue 2 application bundled by the lightning fast build tool <a href="https://github.com/vitejs/vite">Vite</a>
</p>

<p align="center">
 <a href="https://vite-vue2-starter.netlify.app"> ✨ Live Demo</a>
</p>

# 🔥 Features

* ⚡️ [Vite 2](https://github.com/vitejs/vite), [Vue 2](https://github.com/vuejs/vue) and [Composition-API](https://github.com/vuejs/composition-api)
* 🚦 [Vue-Router](https://github.com/vuejs/vue-router)
* 🎨 [Windi CSS](https://github.com/windicss/vite-plugin-windicss) - on-demand Tailwind CSS with speed and dark mode
* 📦 [Components auto importing](https://github.com/antfu/unplugin-vue-components)
* 😃 [Icons as Vue components](https://github.com/antfu/unplugin-icons) - powered by [Iconify](https://github.com/iconify/iconify)
* 🧰 [VueUse](https://github.com/vueuse/vueuse) - collection of essential Vue Composition Utilities
* 🔍 ESLint
* 🦾 Typescript

# 📦 Vite plugins

* [`vite-plugin-vue2`](https://github.com/underfin/vite-plugin-vue2) -
  Vue 2 support for Vite
* [`vite-plugin-windicss`](https://github.com/windicss/vite-plugin-windicss) -
  WindiCSS/TailwindCSS for Vite
* [`unplugin-vue-components`](https://github.com/antfu/unplugin-vue-components) -
  On demand components auto importing for Vite
* [`unplugin-icons`](https://github.com/antfu/unplugin-icons) -
  Access thousands of icons as Vue components in Vite

# 🚀 Getting started

## GitHub Template

[Create a repo from this template on GitHub](https://github.com/lstoeferle/vite-vue2-windicss-starter/generate)

When you use this template, try follow the checklist to update your info properly

- [ ] Rename `name` field in `package.json`
- [ ] Change the author name in `LICENSE`
- [ ] Change the app name in `.env`
- [ ] Change the favicon in `public`
- [ ] Clean up the README(s) and remove routes

## Clone

If you prefer to do it manually with a cleaner git history

```bash
npx degit lstoeferle/vite-vue2-windicss-starter my-vite-vue2-app
cd my-vite-vue2-app
yarn install
```

# Usage

## Development

Just run and visit [http://localhost:8080](http://localhost:8080)

```bash
yarn dev
```

## Build

To build the App, run

```bash
yarn build
```

And you will see the generated files in `dist`, which are ready to be served.

# Why

Vue 3 is awesome, but we should not forget about supporting Vue 2 ♥️