Skip to content

Latest commit

聽

History

History
53 lines (35 loc) 路 2.22 KB

README.md

File metadata and controls

53 lines (35 loc) 路 2.22 KB
Raw

An all-in-one starter pack

A Vue 馃挌 production ready 馃ぉ template for building bleeding edge 馃槑 web apps for all platforms 馃専. Has Capacitor 馃摫 and Tauri 馃捇 pre-configured and setup.

New in V2 :

  • Upgrade to Vue 3.4 and enable props-destructure.
  • Upgrade to Vite 5 and update dependencies.
  • Move to unlugin-vue-router for file based routing(From the author of Vue-router).
  • File based routing that works with Ionic Router, which adds transition between pages and back button navigation on mobile.
  • Use vite-tsconfig-paths for vite paths.
  • Update all scripts and project to use ESM.
  • Add auto-import with unplugin-auto-import - All vue exports, Vue router exports.

Planned for Later in V2:

  • Update UnoCSS to Tailwind v4(To benefit from Oxide Complier and other updates).

Why use this template ?

  • You might don't want to go through the hassle of setting up linter, formatter, router, store etc and still want the [latest vue].
  • If you use the ionic components as your base for components, in future you can build your web app as an android or ios app with Capacitor.
  • File structure based routing and UnoCSS for atomic css.
  • Capacitor is present for mobile and Tauri for desktops.
  • Eslint for linting and prettier for formatting files ( and yes both work combined without issues ).
  • Husky is setup and is being used for commit linting.
  • Vite is used for superior dev experience.
  • Setup so that, VS Code suggests all needed extensions for a good dev experience.
  • Live servers with dev-ios, dev-android & dev-tauri for easier dev experience.

Getting Started 馃ぉ

Note:

pnpm is used and recommended for this project. If any other package manager is used, please go through the scripts folder to modify as needed.

Run the command given below in the root directory

pnpm project-setup

Custom Scripts:

All custom scripts with brief comments can be found in scripts directory. All of them have been added to package.json to be invoked.

Note:

This project will be updated yearly, updating all dependencies to the latest version and maybe even replace some tech for newer and better ones or remove deprecated ones.