/vue3-pinia-quasar-ts

A minimal template that hooks up Vue 3, Pinia (Vuex 5), Quasar, Vue Router 4, and TypeScript

Primary LanguageVue

Vue3, Vite, Pinia (Vuex 5), Vue Router 4, Quasar, TypeScript Starter Template

This repo contains a starter template that connects the following pieces:

This project has been configured with Material Design Icons for Quasar. If you'd like to use a different configuration, see the Quasar docs.

Rationale

This is inspired by Evan You's presentation at VueConf Toronto on the future state of Vue development.

Having worked in Vue and React, one thing that is clear is that the Vue community reflects the fact there is a bit more of what Fred Brookes terms "conceptual integrity" because of the nature of how the ecosystem is being designed and architected as a community with a clear direction and leadership.

In the Vue ecosystem, there are a clear set of "best practices" which are coalescing around key building blocks which simplifies the overall architecture and, in my opinion, enhances productivity.

Whereas in the React world, one might have to choose between Redux or Mobx (or Jotai or Zustand or Valtio) and live with the compromises of one or the other, I kind of appreciate the fact that Pinia simply got lifted up to Vuex 5 instead of forking and creating two different, fragmented practices for state management. These core functions of building front-end applications should "just work".

Many of the improvements in Evan's talk have made working with Vue much, much more streamlined in my opinion and this starter template pulls them all together!

Usage

cd web
yarn
yarn run dev

See the Vite template README for more details and notes.

Organization

The code has been organized under the /web directory (planning on adding example backends).

Highlights are below:

/src/App.vue                        # Entry point
/src/layouts/MainLayout.vue         # The outer chrome (left nav, top bar)
/src/views/SampleView.vue           # Example of a view or page displayed in the layout
/src/components/HelloWorld.vue      # Default component example with the Vite template
/src/router/routes.ts               # Defines the routes
/src/stores/appState.ts             # Sample application state store

The HelloWorld.vue shows an example of how to use the global application state store provided by Pinia.

Of note with Pinia is that we get full intellisense 🎉 compared to Vuex. If you need to, you can create multiple stores (see the Pinia docs for examples).

Additionally, with Volar instead of Vetur, we finally get full intellisense in the templates as well!

Notes:

If you're not familiar with Quasar, it is one of the best and most complete front-end frameworks out there. Compared to the more popular Vuetify, it is:

  • more "complete"
  • has better controls
  • has fantastic, rich documentation and code examples
  • comes with pretty much everything one needs; I've rarely found myself having to pull in additional libraries when working with Quasar

All of this means that you can build apps faster and with less friction. I have built several apps now with Quasar (CovidCureID is another public project of mine) and I find it incredibly productive.

One key note is that the approach used in this project with Vite loses some of the power of Quasar as it does not take advantage of the Quasar CLI (one of the best parts of Quasar). The Quasar team is working on swapping WebPack for Vite.