Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/shamscorner/vitesse-stackter-clean-architect

If you are really into the "Vitesse" starter template created by Anthony Fu (Vue core team member) but want to use the clean architectural pattern instead of monolithic architecture, then you can clone this repo and use your own project. Have fun 🙂!
https://github.com/shamscorner/vitesse-stackter-clean-architect

clean-architecture clean-code javascript modular-design tailwindcss vite vue windicss

Last synced: 1 day ago
JSON representation

If you are really into the "Vitesse" starter template created by Anthony Fu (Vue core team member) but want to use the clean architectural pattern instead of monolithic architecture, then you can clone this repo and use your own project. Have fun 🙂!

Awesome Lists containing this project

README 

        


  Vitesse - Opinionated Vite Starter Template






Mocking up web app with Vitesse(speed)
 with modular design pattern.








If you are really into the "Vitesse" starter template created by [Anthony Fu](https://github.com/antfu) (Vue core team member) but want to use the clean architectural pattern instead of monolithic architecture, then you can clone this repo and use your own project. If you want a quick introduction concept, you can read this very short [blog post](https://www.shamscorner.com/blog/vue-3-vite-modular-architecture-vitesse).









Live Demo








## Features



- ⚡️ [Vue 3](https://github.com/vuejs/core), [Vite 2](https://github.com/vitejs/vite), [pnpm](https://pnpm.io/), [ESBuild](https://github.com/evanw/esbuild) - born with fastness



- 🗂 [File based routing](./src/common/pages)



- 📦 [Components auto importing](./src/common/components)



- 🍍 [State Management via Pinia](https://pinia.vuejs.org/)



- 📑 [Layout system](./src/common/layouts)



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



- 🎨 [Tailwind CSS V3](https://tailwindcss.com/) - next generation utility-first CSS framework



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



- 🌍 [I18n ready](./locales)



- 🚀 Shipped with [Apollo GraphQL](https://www.apollographql.com/)



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



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



- 🤙🏻 [Reactivity Transform](https://vuejs.org/guide/extras/reactivity-transform.html) enabled



- 📥 [APIs auto importing](https://github.com/antfu/unplugin-auto-import) - use Composition API and others directly



- 🖨 Static-site 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



<br>



## Pre-packed



### UI Frameworks



- [Tailwind CSS V3](https://tailwindcss.com/) - Rapidly build modern websites without ever leaving your HTML



### 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/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.vuejs.org) - 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

- [`unplugin-auto-import`](https://github.com/antfu/unplugin-auto-import) - Directly use Vue Composition API and others without importing

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

- [`vite-plugin-vue-markdown`](https://github.com/antfu/vite-plugin-vue-markdown) - 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/bundle-tools/tree/main/packages/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

- [`vite-ssg-sitemap`](https://github.com/jbaubree/vite-ssg-sitemap) - Sitemap generator

- [`vite-plugin-vue-inspector`](https://github.com/webfansplz/vite-plugin-vue-inspector) - jump to local IDE source code while click the element of browser automatically

- [Vue Apollo GraphQL](https://v4.apollo.vuejs.org/)

  - [@apollo/client](https://github.com/apollographql/apollo-client) - Fully-featured caching GraphQL client with vue integration

  - [@vue/apollo-composable](https://github.com/vuejs/apollo) - Apollo GraphQL functions for Vue Composition API



### Coding Style



- Use Composition API with [`<script setup>` 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) - Static-site 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)



## 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 is also welcome!



###### Official



- [vitesse-lite](https://github.com/antfu/vitesse-lite) - Lightweight version of Vitesse

- [vitesse-nuxt3](https://github.com/antfu/vitesse-nuxt3) - Vitesse for Nuxt 3

- [vitesse-nuxt-bridge](https://github.com/antfu/vitesse-nuxt-bridge) - Vitesse for Nuxt 2 with Bridge

- [vitesse-webext](https://github.com/antfu/vitesse-webext) - WebExtension Vite starter template

- [vitesse-stackter-clean-architect](https://github.com/shamscorner/vitesse-stackter-clean-architect) by [@shamscorner](https://github.com/shamscorner) - A modular clean architecture pattern in vitesse template



###### Community



- [vitesse-ssr-template](https://github.com/frandiox/vitesse-ssr-template) by [@frandiox](https://github.com/frandiox) - Vitesse with SSR

- [vitespa](https://github.com/ctholho/vitespa) by [@ctholho](https://github.com/ctholho) - Like Vitesse but without SSG/SSR

- [vitailse](https://github.com/zynth17/vitailse) by [@zynth17](https://github.com/zynth17) - Like Vitesse but with TailwindCSS

- [vitesse-modernized-chrome-ext](https://github.com/xiaoluoboding/vitesse-modernized-chrome-ext) by [@xiaoluoboding](https://github.com/xiaoluoboding) - ⚡️ Modernized Chrome Extension Manifest V3 Vite Starter Template

- [vitesse-enterprise](https://github.com/FranciscoKloganB/vitesse-enterprise) by [@FranciscoKloganB](https://github.com/FranciscoKloganB) - Consistent coding styles regardless of team-size.

- [vitecamp](https://github.com/nekobc1998923/vitecamp) by [@nekobc1998923](https://github.com/nekobc1998923) - Like Vitesse but without SSG/SSR/File based routing, includes Element Plus

- [vitesse-lite-react](https://github.com/lxy-yz/vitesse-lite-react) by [@lxy-yz](https://github.com/lxy-yz) - vitesse-lite React fork

- [vide](https://github.com/Nico-Mayer/vide) by [@nico-mayer](https://github.com/Nico-Mayer) - Vite superlight Beginner Starter Template

- [vitesse-h5](https://github.com/YunYouJun/vitesse-h5) by [@YunYouJun](https://github.com/YunYouJun) - Vitesse for Mobile

- [bat](https://github.com/olgam4/bat) by [@olgam4](https://github.com/olgam4) - Vitesse for SolidJS



## Try it now!

> This project requires Node == 17.6.0



### GitHub Template



[Create a repo from this template on GitHub](https://github.com/shamscorner/vitesse-stackter-clean-architect/generate).



### Clone to local



If you prefer to do it manually with the 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

```



## Checklist



When you use this template, try follow the checklist to update your info properly



- [ ] Change the author name in `LICENSE`

- [ ] Change the title in `App.vue`

- [ ] Change the hostname in `vite.config.ts`

- [ ] Change the favicon in `public`

- [ ] Remove the `.github` folder which contains the funding info

- [ ] Clean up the READMEs and remove routes

- [ ] Update client service url for Apollo GraphQL in `apollo.config.js` if you use GraphQL API

- [ ] Update http link for GraphQL API in `src/common/ApolloClient.ts` if you use GraphQL API



And, enjoy :)



## Usage



### Development



Just run and visit http://localhost:3333



```bash

pnpm dev

```



### Build



To build the App, run



```bash

pnpm build

```



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



### Separation of Concerns



- Create separate folder for each module and place them under `/src` folder

- The following folders are auto imported within each module

    - `components/`

    - `modules/`

    - `pages/`

    - `stores/`

- Place all the layouts in the `common/layouts` folder

- Place all the custom styles in the `common/styles` folder and import them into `main.css`



### Deploy on Netlify



Go to [Netlify](https://app.netlify.com/start) and select your clone, `OK` along the way, and your App will be live in a minute.



### Docker Production Build



First, build the vitesse image by opening the terminal in the project's root directory.



```bash

docker buildx build . -t vitesse:latest

```



Run the image and specify port mapping with the `-p` flag.



```bash

docker run --rm -it -p 8080:80 vitesse:latest

```



## 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)](#variations)