.github | ||
.vscode | ||
locales | ||
public | ||
scripts | ||
src | ||
.gitignore | ||
index.html | ||
LICENSE | ||
netlify.toml | ||
package.json | ||
pnpm-lock.yaml | ||
postcss.config.js | ||
README.md | ||
tailwind.config.js | ||
tsconfig.json | ||
vite.config.ts |
Mocking up web app with ⚡️Vitesse
Features
-
📲 PWA
-
🎨 TailwindCSS v2.0 with dark mode out-of-box
-
🔥 Use the new
<script setup>
style -
🖨 Server-side generation (SSG) via presite
-
🦾 TypeScript, of course
-
☁️ Deploy on Netlify, zero-config
Pre-packed
UI Frameworks
- Tailwind CSS - with built-in dark mode!
- Tailwind Typography - Typography for Tailwind
Icons
- Iconify - use icons from any icon sets 🔍Icônes
- PurgeIcons - bundles only the icons that you use
Plugins
- Vue Router
- vite-plugin-voie - file system based routing
- vite-plugin-components - components auto import
- vite-plugin-pwa - PWA
- vite-plugin-md - Markdown as components / components in Markdown
- markdown-it-shiki - Shiki for syntax highlighting
- vue-i18n - internationalization
- VueUse - collection of useful composition APIs
Coding Style
- Use Composition API with
<script setup>
SFC - ESLint with @antfu/eslint-config-vue, single quotes, no semi.
Dev tools
- TypeScript
- Vue TypeScript Plugin - better type support for Vue
- pnpm - fast, disk space efficient package manager
- presite - Server-side generation
- Netlify - deploy
- VS Code Extensions
Variations
As this template is strongly opinionated, the following provides a curated list for community maintained variations with different preferences and feature sets. Check them out as well. PR to add yours are also welcome!
Try it now!
Github Template
Create a repo from this template on Github.
Clone to local
If you prefer to do it manually with cleaner git history
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
Checklist
When you use this template, try follow the checklist to update your info properly
- Rename
name
field inpackage.json
- Change the author name in
LICENSE
- Change the title in
index.html
- Change the favicon in
public
- Remove the
.github
folder which contains the funding info - Clean up the READMEs and remove routes
And, enjoy :)
Usage
Development
Just run and visit http://localhost:3333
pnpm dev
Build
To build the App, run
pnpm build
And you will see the generated file in dist
that ready to be served.
Deploy on Netlify
Go to Netlify and select your clone, OK
along the way, and your App will be live in a minute.
Why
I have created several Vite apps recently. Setting the configs up is kinda the bottleneck for me to make the ideas simply come true within 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. (see community maintained variation forks)