Vite Project Template Vue Ts
Advanced Structure for vite with template vue 3.x and ts. It contains advanced env support, integrate tailwindcss, easy and clearly to split chunks. And some project's formatter like eslint, editorconfig, prettier, lint-stage, husky, commitizen
Overview
The advanced structure and configuration for a Vite + Vue 3.x + TypeScript project presents a modern development experience that simplifies management and increases productivity. By utilizing JavaScript files for defining environment variables, developers are ushered into a more flexible and intuitive process compared to traditional .env files. This project aims to streamline how developers organize and use their resources, making it particularly useful for those familiar with JavaScript.
This setup not only enhances the structure of a typical Vite project but also provides built-in utility features such as automatic suggestions for available environment variables. The organization of files and directories promotes efficient coding practices while providing a comprehensive framework that can accommodate complex applications.
Features
- Environment Directory: Contains environment variable files as .mjs files for better management and flexibility compared to .env files.
- Improved Variable Definitions: Allows developers to define environment variables of any type, not just strings, enhancing the overall configurability.
- Automatic Suggestions: The ImportMeta.d.ts generates automatically, providing code editors with the ability to suggest available environment variables, significantly speeding up the development process.
- Organized File Structure: Features a clear organization with directories for components, pages, configuration files, and assets, which helps maintain a clean project structure.
- Centralized Asset Management: The src directory effectively handles all assets and logic, enabling easy access and management of styles, images, and other resources.
- Custom Utility Functions: Facilitates the inclusion of customized utilities such as the Composition API and libraries, allowing for better reusability and modular code.
- Simple Registration Process: The streamlined registration of new environment variables through env-register.mjs makes it quick and easy to manage API endpoints and other configurations.
- Vite
Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects
- Vue
Vue.js is a lightweight and flexible JavaScript framework that allows developers to easily build dynamic and reactive user interfaces. Its intuitive syntax, modular architecture, and focus on performance make it a popular choice for modern web development.
- SCSS
SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.
- Tailwind
Tailwind CSS is a utility-first CSS framework that provides pre-defined classes for building responsive and customizable user interfaces.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.