Vue Templates Logo Vue Templates
Vue Starter Kit screenshot

Vue Starter Kit

Author Avatar Theme by Baloise
Updated: 20 Jun 2022
6 Stars

A starter kit for building a standard navigation-style app with Vue, typescript and webpack by CoP-Web

Github

Categories

Vite Scss

Overview

This product is a Vue 3 and Typescript starter kit that provides a template for developing applications using Vite. It includes various plugins, libraries, and tools to streamline the development process. The template comes with a component library, router, state management, form validation, internationalization, http client, testing frameworks, linting, formatting, and documentation. It is recommended to install the Visual Studio Code IDE and the required extensions for a seamless development experience. The Vue Mastery learning platform is also suggested for further understanding of Vue 3.

Features

  • Component library: Baloise Design System
  • Router: Vue Router
  • State Management: Pinia
  • Form Validation: VeeValidate
  • Internationalization: Vue i18n
  • Http client: Axios
  • Testing: Vitest
  • E2E Testing: Cypress
  • Linting: ESlint
  • Formatting: Prettier
  • Documentation: Storybook
  • Recommended Utilities:
    • JavaScript utility library: Lodash
    • JavaScript date library: date-fns

Installation

To get started, clone the vue-starter-kit repository onto your machine. Navigate into the root folder of the project and install the npm dependencies. Once the project is set up, you can serve the application using the following command:

npm run serve

The development server will run at http://localhost:3000/.

The following npm scripts are available for different tasks:

  • install: Installs all the dependencies listed in the package.json.
  • serve: Serves the application on the development server at http://localhost:3000/.
  • docs: Starts the local Storybook server at http://localhost:6006/.
  • testUnit: Runs unit tests with Vitest.
  • testE2E: Starts the development server and runs Cypress E2E tests against it.
  • build: Builds the application for production release. The built application will be in the dist folder.
  • lint: Lints the whole src folder. Linting is also executed before the build.
  • format: Formats all source files using Prettier.

Summary

The Vue 3 and Typescript starter kit provides a comprehensive template for developing applications using Vite. It includes essential plugins and libraries to handle routing, state management, form validation, internationalization, http requests, testing, linting, and formatting. The usage of recommended utilities such as Lodash and date-fns is suggested. The installation process involves cloning the repository, installing dependencies, and running npm scripts to serve, test, build, lint, and format the application. The template aims to streamline the development process and provide a solid foundation for Vue 3 and Typescript projects.