Giter Club home page Giter Club logo

inguide's Introduction

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
  • Pinia store (fully typed Vuex store is available up to template version 1.13)
  • Routing using vue-router 4
  • TypeScript 5
  • 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/typography
    • @tailwindcss/forms
  • 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 + component tests
  • GitHub workflows
    • Renovatebot for keeping up with dependencies
    • Automated unit + component tests
    • Automated e2e tests
    • Coverage reporting in PR comments (example)
  • GitLab CI config available up to versions 2.x

Elsewhere

Contributing

Contributions are welcome! Please follow the code of conduct when interacting with others.

inguide's People

Contributors

dependabot[bot] avatar itsnothingpersonal avatar lukicenturi avatar pavelfeldman avatar renovate[bot] avatar uninen avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.