An open API service indexing awesome lists of open source software.

https://github.com/ducconit/vue-starter-template

Vue + shadcn ui + pinia + tanstack query
https://github.com/ducconit/vue-starter-template

vue-starter-template vue-template-project

Last synced: 12 days ago
JSON representation

Vue + shadcn ui + pinia + tanstack query

Awesome Lists containing this project

README

        

# Vue Starter Template

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Vue.js](https://img.shields.io/badge/Vue.js-3.x-green.svg)](https://vuejs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue.svg)](https://www.typescriptlang.org/)
[![Vite](https://img.shields.io/badge/Vite-latest-purple.svg)](https://vitejs.dev/)

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

## Features

- ๐Ÿš€ [Vue 3](https://vuejs.org/) with Composition API and ``
- ๐Ÿ”ง [TypeScript](https://www.typescriptlang.org/) for type safety
- โšก๏ธ [Vite](https://vitejs.dev/) for fast development and optimized builds
- ๐Ÿ“ฆ [Pinia](https://pinia.vuejs.org/) for state management
- ๐Ÿ”„ [Vue Router](https://router.vuejs.org/) for client-side routing
- ๐Ÿงช Testing setup with [Vitest](https://vitest.dev/)
- ๐ŸŽจ CSS preprocessing with SCSS
- ๐Ÿ“ฑ Responsive design utilities
- ๐Ÿ”’ Authentication flow implementation
- ๐Ÿงฉ Component architecture best practices

## Getting Started

### Prerequisites

- Bun

### Installation

```bash
# 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

```bash
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](https://vuejs.org/guide/introduction.html).

For TypeScript in Vue, refer to the [Vue TypeScript Guide](https://vuejs.org/guide/typescript/overview.html).

## 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](LICENSE) file for details.

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=ducconit/vue-starter-template&type=Date)](https://www.star-history.com/#ducconit/vue-starter-template&Date)