ivy-rong / vue-ts-starter-template

🍀 An opinionated Vue 3/TypeScript starter template.

Vue Starter Template

English / 简体中文

🍀 An opinionated Vue 3/TypeScript starter template.

Features

• Based on Vue 3, Vite, pnpm
• TypeScript, of course
• Naive UI as UI framework
• Tailwind CSS for rapid development based on atomic CSS
• Sass for CSS pre-processing
• Vue Router for routing management
• Pinia for global state management
• Axios for request management
• [iconify/json] and [unplugin-icons] for icon management, can use icones quickly
• [unplugin-auto-import] and [unplugin-vue-components] for automatic import, free your hands
• ESLint for code checking
• Prettier for code formatting
• [cspell] for code spell checking
• Husky and [lint-staged] and [commitlint] for Git commit management
• Docker and Docker Compose for containerization
• Use @/* as absolute path
• Deploy on Vercel, zero config

Tech Stack

• Vue 3
• TypeScript
• Vite
• Naive UI
• Sass

Code Style

• Airbnb JavaScript Style Guide

Getting Started

GitHub Template

Vue Starter Template requires Node version >=14.16.0

Create a repo using this template.

Clone to local

If you prefer to do it manually with a cleaner Git history then follow these steps:

npx degit recallwei/vue-starter-template my-app
cd my-app
pnpm i

Checklist

When using this template, try to update your own information correctly according to the checklist:

• Clean up README.md
• Change author name in LICENSE
• Change project name, description, author, etc. in package.json
• Modify environment variables in .env and delete the file .env.example which is an example of environment variables
• Modify the site meta data in index.html
• Change favicon.ico in the /public directory
• Change the interface proxy in vite.config.ts
• Change the site meta data in src/app.config.ts
• Delete the example API in the src/api directory
• Delete the example images in the src/assets/images directory
• Delete the example route in the src/router directory
• Delete the example view in the src/views directory
• Delete the example store in the src/store directory

Notice

• xxx

Usage

Environment

• Node.js >=16.14.0
• pnpm

Config Environment Variables

Config .env file, refer to .env.example.

Install

pnpm i

Start

pnpm dev

Build

pnpm build

Known Issue

• xxx

License

MIT License © 2023 Bruce Song