Overview

Vulcan is a Vue 3 template that utilizes Vite 4, pnpm, and esbuild to provide fast development and build times. It includes features such as Typescript support, Component Auto Import, pinia for state management, i18n support for internationalization, and more. It also includes pre-packed plugins like Vue-Router, Pinia, Vue-i18n, and axios for easier development. Vulcan aims to improve developer productivity by providing a streamlined and efficient development environment.

Features

• Vue 3, Vite 4, pnpm, esbuild: Utilizes the latest technologies to provide fast development and build times.
• Typescript: Adds static typing to the project for enhanced code quality and development experience.
• Component Auto Import: Automatically imports components, making it easier to work with Vue components.
• pinia: A state management library for Vue 3 that provides a powerful and intuitive API for managing application state.
• <script setup> syntax: Uses the new SFC setup syntax for more concise and clean code.
• i18n Support Internationalization: Includes support for internationalization to make it easier to translate the application.
• APIS Auto Import: Automatically imports APIs and other directories, improving code organization and development experience.
• Unit test with Vitest, E2E test with Cypress: Provides testing utilities for both unit testing and end-to-end testing.
• postcss / sass: Supports CSS pre-processors for easier styling.
• axios encapsulation: Provides better API management and includes APIs code in documentation.
• API Mock Data: Includes a mock dev server for mocking API requests during development.
• px to viewport: Provides a plugin for converting pixels to viewport units for responsive design.
• eslint / prettier: Includes linting and formatting configuration for improved code quality.
• git hooks - format git commit: Configures git hooks to automatically format commits.
• Pre-packed Plugins: Includes pre-configured plugins for Vue-Router, Pinia, Vue-i18n, and more for faster development and setup.

Installation

To install Vulcan, follow the steps below:

1. Make sure you have Node.js version >= 14.18 installed.
2. Clone the Vulcan repository to your local machine.
3. Update the necessary info properties:
   • Change the author name in LICENSE.
   • Change the name in package.json.
   • Delete any unnecessary demo files.
   • Delete any unnecessary Router.
   • Clear up the README.
4. Run npm install or pnpm install to install the dependencies.
5. To start the development server, run npm run dev or pnpm run dev and visit localhost:8080 in your browser.
6. To build the app, run npm run build or pnpm run build. The built files will be generated in the dist directory.

Summary

Vulcan is a Vue 3 template that incorporates various tools and features to enhance developer productivity. It leverages the latest technologies to provide fast development and build times. With features like Typescript support, Component Auto Import, pinia for state management, and i18n support, Vulcan offers a streamlined and efficient development environment. It also includes pre-packed plugins for popular Vue libraries like Vue-Router and Vue-i18n, making it easier to get started with development. Overall, Vulcan aims to improve the development experience for Vue developers and help them create high-quality applications.