Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/byoungd/modern-vue-template

Modern Vue Stack 2022. Joyful development experience 🎉
https://github.com/byoungd/modern-vue-template

vue3-typescript

Last synced: 4 days ago
JSON representation

Modern Vue Stack 2022. Joyful development experience 🎉

Awesome Lists containing this project

README 

        
## Modern Vue



[Modern Vue](https://github.com/byoungd/modern-vue-template) stack 2022 with **Micro front

end** & **Monorepo** 🎉.



Joyful development experience 😄.



The `main` branch will keep clean for quickly creating Vue3 web app.



Monorepo architecture please visit branch

[monorepo](https://github.com/byoungd/modern-vue-template/tree/monorepo).



## Lang





  


    

      

    

  





## Features



- ⚡️ [Vue 3](https://github.com/vuejs/vue-next),

  [Vite 3](https://github.com/vitejs/vite), [pnpm](https://pnpm.js.org/),

  [ESBuild](https://github.com/evanw/esbuild) - born with fastness



- ⚡️ Build Optimization with compress



- ⚡️ CDN by Uploading static files to OSS



- 🦾 Environmental distinction



- 🦾 **Monorepo** by Rush



- 🎨 Commitlint



- 🎨 Formatting with **prettier**



- 🗂 File based routing



- 📦 Components auto importing



- 🍍 [State Management via Pinia](https://pinia.esm.dev/)



- 📑 Layout system



- 📲 [PWA](https://github.com/antfu/vite-plugin-pwa)



- 🎨 [TailwindCSS](https://github.com/tailwindlabs/tailwindcss) - A utility-first CSS

  framework for rapid UI development.



- 😃

  [Use icons from any icon sets, with no compromise](https://github.com/antfu/unplugin-icons)



- 🌍 I18n ready



- 🗒 [Markdown Support](https://github.com/antfu/vite-plugin-md)



- 🔥 Use the [new `` syntax](https://github.com/vuejs/rfcs/pull/227)



- 🖨 Server-side generation (SSG) via [vite-ssg](https://github.com/antfu/vite-ssg)



- 🦔 Critical CSS via [critters](https://github.com/GoogleChromeLabs/critters)



- 🦾 TypeScript, of course



- ⚙️ Unit Testing with [Vitest](https://github.com/vitest-dev/vitest), E2E Testing with

  [Cypress](https://cypress.io/) on [GitHub Actions](https://github.com/features/actions)



- ☁️ Deploy on Netlify, zero-config

- 📦

  [Extend Script Setup Component Name to co-operate with Vue Devtools](https://github.com/vbenjs/vite-plugin-vue-setup-extend)



> example:



```vue

<template>

  <div class="app">

    <RouterView />

  </div>

</template>



<script setup lang="ts" name="App">

```



> We have removed two features `APIs auto import` and `WindiCSS` since 2022.02.24. For the

> reason:



- `TailwindCSS V3` is fast enough now

- `APIs auto import` might be overwhelming in some scenarios when your projects got large



### Type Imports



```ts

// types.ts



export interface User {

  username: string

  password: string

  avatar?: string

}

```



```html



  import type { User } from '~/types'



  defineProps<User>()



...

```



## Pre-packed



### UI Frameworks



- [TailwindCSS](https://tailwindcss.com/) - lighter and faster, with a bunch of additional

  features!



### Icons



- [Iconify](https://iconify.design) - use icons from any icon sets

  [🔍Icônes](https://icones.netlify.app/)

- [`unplugin-icons`](https://github.com/antfu/unplugin-icons) - icons as Vue components



### Plugins



- [Vue Router](https://github.com/vuejs/vue-router)

  - [`vite-plugin-pages`](https://github.com/hannoeru/vite-plugin-pages) - file system

    based routing

  - [`vite-plugin-vue-layouts`](https://github.com/JohnCampionJr/vite-plugin-vue-layouts) -

    layouts for pages

- [Pinia](https://pinia.esm.dev) - Intuitive, type safe, light and flexible Store for Vue

  using the composition api

- [`unplugin-vue-components`](https://github.com/antfu/unplugin-vue-components) -

  components auto import

- [`vite-plugin-pwa`](https://github.com/antfu/vite-plugin-pwa) - PWA

- [`vite-plugin-md`](https://github.com/antfu/vite-plugin-md) - Markdown as components /

  components in Markdown

  - [`markdown-it-prism`](https://github.com/jGleitz/markdown-it-prism) -

    [Prism](https://prismjs.com/) for syntax highlighting

  - [`prism-theme-vars`](https://github.com/antfu/prism-theme-vars) - customizable

    Prism.js theme using CSS variables

- [Vue I18n](https://github.com/intlify/vue-i18n-next) - Internationalization

  - [`vite-plugin-vue-i18n`](https://github.com/intlify/vite-plugin-vue-i18n) - Vite

    plugin for Vue I18n

- [VueUse](https://github.com/antfu/vueuse) - collection of useful composition APIs

- [`@vueuse/head`](https://github.com/vueuse/head) - manipulate document head reactively



### Coding Style



- Use Composition API with

  [`` SFC syntax](https://github.com/vuejs/rfcs/pull/227)

- [ESLint](https://eslint.org/) with

  [@antfu/eslint-config](https://github.com/antfu/eslint-config), single quotes, no semi.



### Dev tools



- [TypeScript](https://www.typescriptlang.org/)

- [Vitest](https://github.com/vitest-dev/vitest) - Unit testing powered by Vite

- [Cypress](https://cypress.io/) - E2E testing

- [pnpm](https://pnpm.js.org/) - fast, disk space efficient package manager

- [`vite-ssg`](https://github.com/antfu/vite-ssg) - Server-side generation

  - [critters](https://github.com/GoogleChromeLabs/critters) - Critical CSS

- [Netlify](https://www.netlify.com/) - zero-config deployment

- [VS Code Extensions](./.vscode/extensions.json)

  - [Vite](https://marketplace.visualstudio.com/items?itemName=antfu.vite) - Fire up Vite

    server automatically

  - [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) - Vue

    3 `<script setup>` IDE support

  - [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) -

    Icon inline display and autocomplete

  - [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) -

    All in one i18n support

  - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)



## Try it now!



> Requires Node >=14



### GitHub Template



[Create a repo from this template on GitHub](https://github.com/byoungd/modern-vue-template/generate).



### Clone to local



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



## Usage



### Development



```

pnpm i



pnpm dev



```



### Build



To build the App, run



```bash



pnpm build



```



With Env:



```bash



pnpm build:test



```



And you will see the generated file in `dist` that ready to be served.



## Thanks



- [Vitesse](https://github.com/antfu/vitesse)



## Final



enjoy :)