diff --git a/README.md b/README.md index 960d2c8..a16e854 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ # view-ui-project-vite +This project build for Vue3, Vue-router, Vuex, ViewUIPlus and Vite. +## Install +```shell +npm install +``` +## Run +```shell +npm run serve +``` +## Build +### Build for Production +```shell +npm run build +``` +### Build for Staging +```shell +npm run build:staging +``` +## Preview +### Preview for Production +```shell +npm run preview +``` +### Preview for Staging +```shell +npm run preview:staging +``` +## Run Eslint +### Run without Fixing -A template project for vue3, vue-router, vuex, ViewUIPlus and vite. \ No newline at end of file +- This operation will also run before git-commit. +```shell +npm run lint +``` +### Run with Fixing +```shell +npm run lint:fix +``` +## .env Description + +- This project exposes environment variables on `import.meta.env` object. +- Different modes (development/staging/production) correspond to different environment files (.env.*). +- .env file is always included, duplicate variables are overwritten by the specific mode file (.env.*).