98 lines
3.1 KiB
Markdown
98 lines
3.1 KiB
Markdown
<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'>
|
|
<a href="https://vitesse.netlify.app/">Live Demo</a>
|
|
</p>
|
|
|
|
<br>
|
|
|
|
## Features
|
|
|
|
- ⚡️ Vue3, Vite, pnpm, ESBuild - born with fastness
|
|
|
|
- 🗂 File based routing
|
|
|
|
- 🎨 TailwindCSS with dark mode out-of-box
|
|
|
|
- 😃 Use icons from any icon sets, with no compromise
|
|
|
|
- 🌍 i18n ready
|
|
|
|
- 🦾 TypeScript, of course
|
|
|
|
- ☁️ Deploy on Netlify, zero config
|
|
|
|
<br>
|
|
|
|
## Pre-packed
|
|
|
|
### UI Frameworks
|
|
|
|
- [Tailwind CSS](https://tailwindcss.com/)
|
|
- [tailwindcss-dark-mode](https://github.com/ChanceArthur/tailwindcss-dark-mode)
|
|
- [variantwind](https://github.com/sibbngheid/variantwind) - shorthands for writing Tailwind CSS
|
|
|
|
### 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
|
|
|
|
### Router
|
|
|
|
- [Vue Router](https://github.com/vuejs/vue-router)
|
|
- [Voie](https://github.com/vamplate/vite-plugin-voie) - file system based routing
|
|
|
|
### Utils
|
|
|
|
- [vue-i18n](https://github.com/intlify/vue-i18n-next) - internationalization
|
|
- [VueUse](https://github.com/antfu/vueuse) - collection of useful composition APIs
|
|
|
|
### Coding Style
|
|
|
|
- Use Composition API with [`<script setup>` SFC](https://github.com/vuejs/rfcs/blob/sfc-improvements/active-rfcs/0000-sfc-script-setup.md)
|
|
- [ESLint](https://eslint.org/) with [@antfu/eslint-config-vue](https://github.com/antfu/eslint-config), single colons, no semi.
|
|
|
|
### Dev tools
|
|
|
|
- [TypeScript](https://www.typescriptlang.org/)
|
|
- [pnpm](https://pnpm.js.org/) - fast, disk space efficient package manager
|
|
- [Netlify](https://www.netlify.com/) - deploy
|
|
- [VS Code Extensions](./.vscode/extensions.json)
|
|
- [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify)
|
|
- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=antfu.i18n-ally)
|
|
- [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss)
|
|
- [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur)
|
|
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
|
|
|
## Try it now!
|
|
|
|
### Github Template
|
|
|
|
[Create a repo from this template on Github](https://github.com/antfu/vitesse/generate).
|
|
|
|
### Clone to local
|
|
|
|
If you prefer do to it manually with cleaner git history
|
|
|
|
```bash
|
|
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
|
|
```
|
|
|
|
## Why
|
|
|
|
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.
|