VUE-START

Transforming Vue projects with boundless creativity.

Important ‼️

Delete /.github/workflows/auto-sync.yml file, it is used to sync this repo with organization one.

Table of Contents

• Overview
• Features
• Repository Structure
• Getting Started
  • Prerequisites
  • Installation
  • Usage

---

Overview

Vue-start is a comprehensive Vue project setup tool that facilitates efficient Vue app development. It seamlessly integrates TypeScript, Vite, Vue Router, and i18n to enhance code quality and development experience. With pre-configured linting, routing, and global components, Vue-start accelerates project initiation and maintains consistency in styling and type safety. This open-source project simplifies Vue app setup and empowers developers to focus on building robust, scalable applications.

---

Features

	Feature	Description
⚙️	Architecture	Vite setup with TypeScript for efficient Vue.js development. Separated layouts, components, and services for clear project structure.
🔩	Code Quality	Strict ESLint rules with tailored configuration for code consistency. Strong type-checking with TypeScript.
📄	Documentation	Detailed comments in code files, README.md for setup and usage instructions.
🔌	Integrations	Vite, Vue Router, Vue I18n, Tailwind CSS, Pinia for state management.
🧩	Modularity	Components, layouts, services separated for reusability. Global types and enums for structured data handling.
🧪	Testing	Jest for unit tests, E2E testing setup missing.
⚡️	Performance	Vite for fast development and build times. Optimal code structure for efficient rendering.
🛡️	Security	Authentication flow with token management. Zod for data validation.
📦	Dependencies	Dependencies on Vite, Vue.js, Tailwind CSS, Zod, vee-validate, i18n libraries.
🚀	Scalability	Structured codebase supports scalability. Vuex or alternative for complex state management could be considered.

---

Repository Structure

└── vue-start/
    ├── .github
    │   └── workflows
    ├── LICENSE
    ├── README.md
    ├── auto-imports.d.ts
    ├── commitlint.config.ts
    ├── components.d.ts
    ├── eslint.config.js
    ├── index.html
    ├── package.json
    ├── pnpm-lock.yaml
    ├── postcss.config.js
    ├── public
    │   └── favicon.svg
    ├── shims.d.ts
    ├── src
    │   ├── @core
    │   ├── App.vue
    │   ├── assets
    │   ├── components
    │   ├── composables
    │   ├── constants
    │   ├── defaults
    │   ├── enums
    │   ├── i18n
    │   ├── icons
    │   ├── layouts
    │   ├── main.ts
    │   ├── pages
    │   ├── plugins
    │   ├── schemas
    │   ├── services
    │   ├── store
    │   ├── types
    │   ├── utils
    │   └── vite-env.d.ts
    ├── tailwind.config.ts
    ├── tsconfig.json
    ├── tsconfig.node.json
    ├── typed-router.d.ts
    └── vite.config.ts

---

Getting Started

Prerequisites

TypeScript: version x.y.z

Installation

Build the project from source:

1. Clone the vue-start repository:

❯ git clone **copy_repo_url**

2. Navigate to the project directory:

❯ cd vue-start

3. Install the required dependencies:

❯ pnpm install

Usage

To run the project, execute the following command:

❯ pnpm run dev