vitesse/README.md

71 lines
2.2 KiB
Markdown
Raw Normal View History

2020-08-10 02:43:04 +08:00
<h1 align='center'><samp>Vitesse</samp></h1>
<p align='center'>
<samp>Opinionated <a href="https://github.com/vitejs/vite">Vite</a> Starter Template</samp>
</p>
<p align='center'>
<sup><em>Mocking up web app with <b>vitesse</b></em></sup>
</p>
<br>
<p align='center'>
2020-08-10 15:42:19 +08:00
<a href="https://vitesse.netlify.app/">Live Demo</a>
2020-08-10 02:43:04 +08:00
</p>
<br>
## Pre-packed
### UI Frameworks
- [Tailwind CSS](https://tailwindcss.com/)
- [tailwindcss-dark-mode](https://github.com/ChanceArthur/tailwindcss-dark-mode)
2020-08-10 20:31:44 +08:00
- [variantwind](https://github.com/sibbngheid/variantwind)
2020-08-10 02:43:04 +08:00
2020-08-10 19:24:52 +08:00
### Icons
- [Iconify](https://iconify.design) - use icons from any icon sets [🔍Icônes](https://icones.netlify.app/)
- [PurgeIcons](https://github.com/antfu/purge-icons) - bundles only the icons that you use
2020-08-10 02:43:04 +08:00
### Router
- [Vue Router](https://github.com/vuejs/vue-router)
2020-08-10 13:37:49 +08:00
- [Voie](https://github.com/vamplate/vite-plugin-voie) - file system based routing
2020-08-10 02:43:04 +08:00
### Utils
2020-08-10 11:17:26 +08:00
- [vue-i18n](https://github.com/intlify/vue-i18n-next)
2020-08-10 19:24:52 +08:00
- [VueUse](https://github.com/antfu/vueuse) - collection of useful composition APIs
2020-08-10 02:43:04 +08:00
### Misc
- Use Composition API with [`<script setup>` SFC](https://github.com/vuejs/rfcs/blob/sfc-improvements/active-rfcs/0000-sfc-script-setup.md)
### Dev tools
- [Typescript](https://www.typescriptlang.org/)
2020-08-10 19:24:52 +08:00
- [pnpm](https://pnpm.js.org/) - fast, disk space efficient package manager
2020-08-10 02:43:04 +08:00
- [Netlify](https://www.netlify.com/)
- [ESLint](https://eslint.org/) with [@antfu/eslint-config-vue](https://github.com/antfu/eslint-config)
2020-08-10 11:17:26 +08:00
- [VS Code Extensions](./.vscode/extensions.json)
2020-08-10 02:43:04 +08:00
2020-08-10 11:17:26 +08:00
## Try it now!
[Create a repo from this template on Github](https://github.com/antfu/vitesse/generate).
Or if you prefers do to manually with cleaner git history
2020-08-10 02:43:04 +08:00
```bash
2020-08-10 11:17:26 +08:00
npx degit antfu/vitesse my-vitesse-app
cd my-vitesse-app
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
2020-08-10 02:43:04 +08:00
```
## Why
2020-08-10 11:17:26 +08:00
I have created several Vite apps recently. Setting the configs up is kinda the bottleneck for me to make the idea simply comes true in a very short time.
So I made this starter template for myself to create apps more easily, along with some good practices that I have learned from making those apps. It's strongly opinionated, but feel free to tweak it or even maintains your own forks.