/ts-vue3-pinia-tailwind-boilerplate

Primary LanguageTypeScript

Vite + Vue 3 + Typescript + Tailwind Starter

Simple, opinionated, fully typed, and production-ready project template for Vite.

This template is practical and batteries included but not overly complex or bloated. Also explicit configuration over magic; it should be easy to understand how everything works, strip out anything you don't need, and fast to modify things to your needs.

Includes plenty of examples and documentation of how to do things but minimal cruft to delete to get you going.

Please check out the homepage for full docs. A detailed changelog is available. This repository is also mirrored on GitLab.

Features

  • Vue 3.2
  • Pinia store (fully typed Vuex store is available up to version 1.13)
  • Routing using vue-router 4
  • TypeScript 4.6
  • Automatic package and component imports w/ unplugin-auto-import and unplugin-vue-components
  • Tailwind CSS 3 w/ following plugins and configuration preinstalled:
    • @tailwindcss/aspect-ratio
    • @tailwindcss/line-clamp
  • PostCSS 8 w/ postcss-nesting plugin and cssnano for minimizing production CSS
  • Eslint
  • Prettier
  • Alias @ to <project_root>/src
  • Predefined and fully typed global variables:
    • VITE_APP_VERSION is read from package.json version at build time
    • VITE_APP_BUILD_EPOCH is populated as new Date().getTime() at build time
  • Using newest script setup syntax w/ Ref sugar (see the official Script Setup documentation and Ref Sugar RFC discussion)
  • Vitest unit tests
  • Cypress.io e2e tests (configured similarly to vue-cli)
  • Cypress.io component tests
  • GitHub workflows
    • Dependabot
    • Automated unit tests
    • Automated component tests
    • Automated e2e tests
  • GitLab CI
    • Automated unit tests
    • Automated component tests
    • Automated e2e tests