diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..0a9a9939eb31683026bd38982957ca0696f23d01 --- /dev/null +++ b/README.en.md @@ -0,0 +1,73 @@ +This project is a basic project template built with Webpack and Vue CLI, suitable for front-end projects developed using Vue.js. Below is the structure and main features of the project: + +--- + +## ๐Ÿ“ฆ Project Structure + +``` +webpack-vue-cli/ +โ”œโ”€โ”€ config/ # Webpack configuration files +โ”‚ โ”œโ”€โ”€ webpack.config.dev.js # Development environment configuration +โ”‚ โ””โ”€โ”€ webpack.config.prod.js # Production environment configuration +โ”œโ”€โ”€ public/ # Static resources +โ”‚ โ”œโ”€โ”€ favicon.ico +โ”‚ โ””โ”€โ”€ index.html # Main HTML page +โ”œโ”€โ”€ src/ # Source code directory +โ”‚ โ”œโ”€โ”€ App.vue # Root Vue component +โ”‚ โ”œโ”€โ”€ main.js # Entry JS file +โ”‚ โ”œโ”€โ”€ router/ # Vue Router configuration +โ”‚ โ”‚ โ””โ”€โ”€ index.js # Route definitions +โ”‚ โ”œโ”€โ”€ views/ # Page view components +โ”‚ โ”‚ โ”œโ”€โ”€ About.vue # About page +โ”‚ โ”‚ โ””โ”€โ”€ Home.vue # Home page +โ”œโ”€โ”€ .eslintrc.js # ESLint configuration +โ”œโ”€โ”€ .gitignore # Git ignore configuration +โ”œโ”€โ”€ babel.config.js # Babel configuration +โ”œโ”€โ”€ eslint.config.js # ESLint configuration file +โ”œโ”€โ”€ package.json # Project dependencies and script configuration +โ””โ”€โ”€ pnpm-lock.yaml # pnpm dependency lock file +``` + +--- + +## ๐Ÿš€ Features + +- **Webpack Build System**: Supports build configurations for development and production environments. +- **Vue.js Framework**: Built with Vue CLI, supports component-based development. +- **Vue Router**: Integrated routing functionality, supports multi-page navigation. +- **ESLint & Babel**: Code linting and support for modern JavaScript features. +- **Modular Structure**: Clear directory structure for easy project maintenance and scalability. + +--- + +## ๐Ÿ› ๏ธ Installation and Usage + +### Install Dependencies + +```bash +pnpm install +``` + +### Start Development Server + +```bash +pnpm run serve +``` + +### Build Production Version + +```bash +pnpm run build +``` + +--- + +## ๐Ÿ“ Contribution Guide + +Pull Requests or Issues are welcome. Please follow the project's coding standards and ensure tests pass. + +--- + +## ๐Ÿ“„ License + +This project is licensed under the MIT License. For details, please refer to the `package.json` or the relevant license file. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..2a27cf44ea51a5d35ad41df8853122255f29b4b0 --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +่ฏฅ้กน็›ฎๆ˜ฏๅŸบไบŽ Webpack ๅ’Œ Vue CLI ๆž„ๅปบ็š„ไธ€ไธชๅŸบ็ก€้กน็›ฎๆจกๆฟ๏ผŒ้€‚็”จไบŽไฝฟ็”จ Vue.js ๅผ€ๅ‘็š„ๅ‰็ซฏ้กน็›ฎใ€‚ไปฅไธ‹ๆ˜ฏ้กน็›ฎ็š„็ป“ๆž„ๅ’Œไธป่ฆๅŠŸ่ƒฝ่ฏดๆ˜Ž๏ผš + +--- + +## ๐Ÿ“ฆ ้กน็›ฎ็ป“ๆž„ + +``` +webpack-vue-cli/ +โ”œโ”€โ”€ config/ # Webpack ้…็ฝฎๆ–‡ไปถ +โ”‚ โ”œโ”€โ”€ webpack.config.dev.js # ๅผ€ๅ‘็Žฏๅขƒ้…็ฝฎ +โ”‚ โ””โ”€โ”€ webpack.config.prod.js # ็”Ÿไบง็Žฏๅขƒ้…็ฝฎ +โ”œโ”€โ”€ public/ # ้™ๆ€่ต„ๆบ +โ”‚ โ”œโ”€โ”€ favicon.ico +โ”‚ โ””โ”€โ”€ index.html # ไธป HTML ้กต้ข +โ”œโ”€โ”€ src/ # ๆบไปฃ็ ็›ฎๅฝ• +โ”‚ โ”œโ”€โ”€ App.vue # ๆ น Vue ็ป„ไปถ +โ”‚ โ”œโ”€โ”€ main.js # ๅ…ฅๅฃ JS ๆ–‡ไปถ +โ”‚ โ”œโ”€โ”€ router/ # Vue Router ้…็ฝฎ +โ”‚ โ”‚ โ””โ”€โ”€ index.js # ่ทฏ็”ฑๅฎšไน‰ +โ”‚ โ”œโ”€โ”€ views/ # ้กต้ข่ง†ๅ›พ็ป„ไปถ +โ”‚ โ”‚ โ”œโ”€โ”€ About.vue # ๅ…ณไบŽ้กต้ข +โ”‚ โ”‚ โ””โ”€โ”€ Home.vue # ้ฆ–้กต +โ”œโ”€โ”€ .eslintrc.js # ESLint ้…็ฝฎ +โ”œโ”€โ”€ .gitignore # Git ๅฟฝ็•ฅๆ–‡ไปถ้…็ฝฎ +โ”œโ”€โ”€ babel.config.js # Babel ้…็ฝฎ +โ”œโ”€โ”€ eslint.config.js # ESLint ้…็ฝฎๆ–‡ไปถ +โ”œโ”€โ”€ package.json # ้กน็›ฎไพ่ต–ๅ’Œ่„šๆœฌ้…็ฝฎ +โ””โ”€โ”€ pnpm-lock.yaml # pnpm ไพ่ต–้”ๅฎšๆ–‡ไปถ +``` + +--- + +## ๐Ÿš€ ๅŠŸ่ƒฝ็‰น็‚น + +- **Webpack ๆž„ๅปบ็ณป็ปŸ**๏ผšๆ”ฏๆŒๅผ€ๅ‘ๅ’Œ็”Ÿไบง็Žฏๅขƒ็š„ๆž„ๅปบ้…็ฝฎใ€‚ +- **Vue.js ๆก†ๆžถ**๏ผšๅŸบไบŽ Vue CLI ๆž„ๅปบ๏ผŒๆ”ฏๆŒ็ป„ไปถๅŒ–ๅผ€ๅ‘ใ€‚ +- **Vue Router**๏ผš้›†ๆˆ่ทฏ็”ฑๅŠŸ่ƒฝ๏ผŒๆ”ฏๆŒๅคš้กต้ขๅฏผ่ˆชใ€‚ +- **ESLint & Babel**๏ผšไปฃ็ ่ง„่Œƒๅ’Œ JavaScript ๆ–ฐ็‰นๆ€งๆ”ฏๆŒใ€‚ +- **ๆจกๅ—ๅŒ–็ป“ๆž„**๏ผšๆธ…ๆ™ฐ็š„็›ฎๅฝ•็ป“ๆž„๏ผŒไพฟไบŽ้กน็›ฎ็ปดๆŠคๅ’Œๆ‰ฉๅฑ•ใ€‚ + +--- + +## ๐Ÿ› ๏ธ ๅฎ‰่ฃ…ไธŽไฝฟ็”จ + +### ๅฎ‰่ฃ…ไพ่ต– + +```bash +pnpm install +``` + +### ๅฏๅŠจๅผ€ๅ‘ๆœๅŠกๅ™จ + +```bash +pnpm run serve +``` + +### ๆž„ๅปบ็”Ÿไบง็‰ˆๆœฌ + +```bash +pnpm run build +``` + +--- + +## ๐Ÿ“ ่ดก็ŒฎๆŒ‡ๅ— + +ๆฌข่ฟŽๆไบค Pull Request ๆˆ– Issueใ€‚่ฏท้ตๅพช้กน็›ฎไปฃ็ ่ง„่Œƒๅนถ็กฎไฟๆต‹่ฏ•้€š่ฟ‡ใ€‚ + +--- + +## ๐Ÿ“„ ่ฎธๅฏ่ฏ + +ๆœฌ้กน็›ฎ้‡‡็”จ MIT ่ฎธๅฏ่ฏใ€‚่ฏฆๆƒ…่ฏทๆŸฅ็œ‹ `package.json` ๆˆ–็›ธๅ…ณ่ฎธๅฏ่ฏๆ–‡ไปถใ€‚ \ No newline at end of file