Top Nuxt 3 Starter Template
The fastest and most comfortable development experience started template.
Everything comes installed for a speedy staring with examples. Simply remove what you don't need and you are good to go :)
With 💚 from @ctwhome, inspired by @antfu vitesse.
Features
- [x] ❇️ Nuxt 3
- [x] 🔥 The
<script setup>
syntax
- [x] 🏎 Zero-config cloud functions and deploy SSR working with Netlify thanks to the new Nuxt 3 Functions
- [x] 📥 APIs auto importing - for Composition API, VueUse and custom composables.
- [x] ESR, File-based routing, components auto importing, modules, etc.
- [x] 🦾 TypeScript
- [x] 💻 .env settings environments
- [x] ⭐️ Format on save with ESLint (VSCode Settings file and WebStorm)
- [x] ⚡️ Vite - Instant HMR
- [x] 📴 PWA - vite-plugin-pwa (thanks to @userquin for the contribution)
- Offline mode, new content available prompt,
- WIP PWA not working correctly.
- [x] 🎨 TailwindCSS 3 - JIT engine by default
- [x] 👩🎨 DaisyUI - Theme CSS components for TailwindCSS
- [x] 🌈 Theme switcher - Custom theme and 22 themes to choose from.
- [ ] 📄 Styled Markdown HTML components
- [x] ✨ All Iconify on-demand - +100.000 SVG icons completely customizable
- [x] 🌐 Multi-language support with vue-i18n-next thanks to @intlify/nuxt3
- [x] YAML, JSON, JSON5 locale files
- [ ] Localize routes: (/en/about, /es/about, ...)
- [ ] 🐘 Supabase - WIP - Full stack development with Auth, Realtime, Storage, and of course PostgreSQL
- [ ] 🍍 State Management via Pinia
- [ ] 📤 Feed RSS generator
Nuxt Modules
- [x] VueUse - a collection of useful composition APIs
- [ ] Pinia - intuitive, type-safe, light, and flexible Store for Vue.
Motivation and Personal Opinion
Nuxt is awesome, I am trying to use Nuxt 3 as much as I can to at least have the same features working that I have on top-nuxt with Nuxt 2.
Installation and running locally
npx degit ctwhome/top-nuxt3 <directory-name>
yarn install
Updating fork
- Add remote from the original repository in your forked repository:
git remote add upstream git://github.com/ctwhome/top-nuxt3.git
git fetch upstream
- Updating your fork from the original repo to keep up with their changes:
git pull upstream main
Start the development server on http://localhost:3000
yarn dev
IDE
We recommend using VS Code with Volar to get the best experience (You might want to disable Vetur if you have it).
Production
Build the application for production:
yarn build
Check out the deployment documentation.