Overview

Vueye is a Vue.js 3 template starter that comes with many components styled using Tailwind CSS and built using Vitejs. It offers a range of features such as file-based routing, components auto-importing, state management via Pinia, a layout system, PWA support, and more. The template is built with a focus on fastness, and it includes various tools and frameworks like UnoCSS, Iconify, Vue Router, and Vite Plugin Pages.

Features

• Vue 3, Vite 2, pnpm, ESBuild: Built with the latest versions of Vue.js, Vite, pnpm, and ESBuild for optimal performance.
• File based routing: Allows for easy navigation and organization of files based on routing.
• Components auto importing: Automatically imports components to ensure efficient development workflow.
• State Management via Pinia: Provides an intuitive, type-safe, light, and flexible store for Vue using the composition API.
• Layout system: Includes a layout system for easily managing the layout of different pages.
• PWA: Supports Progressive Web App functionality for enhanced user experience.
• UnoCSS: Utilizes UnoCSS, an instant on-demand atomic CSS engine, for efficient styling.
• Use icons from any icon sets with classes: Allows for the use of icons from any icon set using classes.
• I18n ready: Provides support for internationalization for multi-language applications.
• Markdown Support: Allows for the use of Markdown in components and components in Markdown.
• Reactivity Transform enabled: Enables the use of reactivity transform for enhanced reactivity in components.
• APIs auto importing: Allows for the direct use of Composition API and other APIs without importing them separately.
• Static-site generation (SSG) via vite-ssg: Provides static-site generation capabilities for efficient build and deployment.
• Critical CSS via critters: Implements critical CSS extraction using critters for enhanced performance.
• TypeScript: Built with TypeScript for type-safe development.
• Unit Testing with Vitest, E2E Testing with Cypress on GitHub Actions: Includes unit testing with Vitest and end-to-end testing with Cypress using GitHub Actions.
• Deploy on Netlify, zero-config: Supports easy deployment on Netlify with zero configuration required.

Installation

To install Vueye, follow the steps below:

1. Make sure you have Node.js installed on your system (version 14 or above).
2. Create a new repository from the Vueye template on GitHub or clone it manually with a cleaner git history.
3. Clone the repository to your local machine.
4. Run the following command to install the required dependencies:

pnpm install

5. To start the development server, run the following command:

pnpm dev

6. Open your browser and visit http://localhost:3333 to see the app running.
7. To build the app, run the following command:

pnpm build

8. The generated files will be available in the dist directory and can be served on any web server.
9. To deploy the app on Netlify, go to Netlify and select your clone. Follow the instructions provided to deploy your app.

Summary

Vueye is a powerful Vue.js 3 template starter that offers a wide range of features for efficient and fast web development. It includes components styled with Tailwind CSS, file-based routing, components auto-importing, state management via Pinia, PWA support, a layout system, and more. With its extensive collection of tools and frameworks, Vueye provides developers with a solid foundation to quickly build and deploy Vue.js applications.