Skip to content

Latest commit

 

History

History
115 lines (70 loc) · 2.43 KB

README_EN.md

File metadata and controls

115 lines (70 loc) · 2.43 KB
Raw

中文版本

vue-vite-element-plus-starter

I. Project Introduction

Online Document Preview

II. Startup Documentation

Globally install docsify-cli

# MacOS `sudo npm install -g docsify-cli`

npm install -g docsify-cli

Launch docs

npm run docs

Access the documentation at http://localhost:3000

III. Startup Project

Install dependencies

# npm install --registry=https://registry.npm.taobao.org

npm install

Development environment

npm run dev

IV. Project Packaging

Joint debugging environment

npm run rd

Testing environment

npm run qa

Production environment

npm run prod

V. ESLint Code Repair

Running the following command will automatically fix the code

npm run lint

VI. Generate changelog

Generate /CHANGELOG.md

npm run changelog

Generate /docs/CHANGELOG.md

npm run changelog-docs

VII. Build and Deploy

docker-compose build
docker-compose up -d

http://localhost:8000

VIII. Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

IX. Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

X. Customize configuration

See Vite Configuration Reference.