Vue Starter Template

A modern starter template for Vue 3 projects using TypeScript, Vite, and best practices for building scalable web applications.

Features

• 🚀 Vue 3 with Composition API and <script setup>
• 🔧 TypeScript for type safety
• ⚡️ Vite for fast development and optimized builds
• 📦 Pinia for state management
• 🔄 Vue Router for client-side routing
• 🧪 Testing setup with Vitest
• 🎨 CSS preprocessing with SCSS
• 📱 Responsive design utilities
• 🔒 Authentication flow implementation
• 🧩 Component architecture best practices

Getting Started

Prerequisites

• Bun

Installation

# Clone the repository
git clone https://github.com/ducconit/vue-starter-template.git
cd vue-starter-template

# Install dependencies
bun install

# Start development server
bun run dev

Build for Production

bun run build

Project Structure

├── public/              # Static assets
├── src/
│   ├── api/            # API service layer
│   ├── assets/         # Assets that will be processed by the build
│   ├── components/     # Reusable Vue components
│   ├── layouts/        # Layout components
│   ├── plugins/        # Vue plugins and extensions
│   ├── router/         # Vue Router configuration
│   ├── stores/         # Pinia stores
│   ├── types/          # TypeScript type definitions
│   ├── utils/          # Utility functions
│   ├── pages/          # Page components
│   ├── App.vue         # Root component
│   └── main.ts         # Application entry point
├── eslint.config.ts    # ESLint configuration
├── .gitignore          # Git ignore rules
├── index.html          # HTML entry point
├── package.json        # Project dependencies and scripts
├── tsconfig.json       # TypeScript configuration
├── vite.config.ts      # Vite configuration
├── bun.lockb           # Bun lock file
└── README.md           # Project documentation

Documentation

For detailed documentation on Vue 3, check out the Vue.js Documentation.

For TypeScript in Vue, refer to the Vue TypeScript Guide.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Star History