diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..dfe4da9a6f7a79e65402866ed4b0e86e0c1015cc --- /dev/null +++ b/README.en.md @@ -0,0 +1,76 @@ +# vit-elment + +vit-elment is a modern frontend project template built with Vite and Element Plus, designed to help developers rapidly set up enterprise-level applications. This project combines Vite's blazing-fast development experience with Element Plus's rich component library, making it ideal for building management dashboards, admin panels, and similar use cases. + +## Features + +- Built with Vite, offering fast cold starts and instant module hot-reloading +- Integrated with Element Plus component library, providing a wide range of UI components +- Supports TypeScript and Vue 3's Composition API +- Includes basic routing configuration and layout structure +- Provides Axios request encapsulation and global style conventions + +## Installation Guide + +1. Ensure Node.js (version >= 14.0.0) and npm/yarn package manager are installed +2. Clone the project to your local machine: + ```bash + git clone https://gitee.com/phpstart/vit-elment.git + ``` +3. Navigate to the project directory and install dependencies: + ```bash + cd vit-elment + npm install + # Or use yarn + yarn install + ``` + +## Usage Instructions + +- Start the development server: + ```bash + npm run dev + # Or use yarn + yarn dev + ``` +- Build the production bundle: + ```bash + npm run build + # Or use yarn + yarn build + ``` +- Run lint checks: + ```bash + npm run lint + # Or use yarn + yarn lint + ``` + +## Directory Structure + +``` +vit-elment/ +├── public/ # Static assets directory +├── src/ # Source code directory +│ ├── assets/ # Project resources +│ ├── components/ # Reusable components +│ ├── router/ # Routing configuration +│ ├── views/ # Page components +│ ├── App.vue # Root component +│ └── main.ts # Entry file +├── .gitignore # Git ignore configuration +└── package.json # Project configuration file +``` + +## Contribution Guide + +Contributions and suggestions are welcome! Please follow these steps: +1. Fork the project repository +2. Create a new branch (`git checkout -b feature/new-feature`) +3. Commit your changes (`git commit -m 'Add new feature'`) +4. Push the branch (`git push origin feature/new-feature`) +5. Submit a Pull Request + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..ccaa97e148cc98bfd81b24ca33e50bd67ecd899b --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +# vit-elment + +vit-elment 是一个基于 Vite 和 Element Plus 构建的现代化前端项目模板,旨在帮助开发者快速搭建企业级应用。该项目结合了 Vite 的极速开发体验和 Element Plus 的丰富组件库,适合用于开发管理后台、仪表盘等应用场景。 + +## 功能特性 + +- 基于 Vite 构建,提供快速冷启动和即时模块热更新 +- 集成 Element Plus 组件库,提供丰富的 UI 组件 +- 支持 TypeScript、Vue 3 的 Composition API +- 包含基础路由配置和布局结构 +- 提供 Axios 请求封装和全局样式规范 + +## 安装指南 + +1. 确保已安装 Node.js(建议版本 >=14.0.0)和 npm/yarn 包管理器 +2. 克隆项目到本地: + ```bash + git clone https://gitee.com/phpstart/vit-elment.git + ``` +3. 进入项目目录并安装依赖: + ```bash + cd vit-elment + npm install + # 或使用 yarn + yarn install + ``` + +## 使用说明 + +- 启动开发服务器: + ```bash + npm run dev + # 或使用 yarn + yarn dev + ``` +- 构建生产环境包: + ```bash + npm run build + # 或使用 yarn + yarn build + ``` +- 运行 lint 检查: + ```bash + npm run lint + # 或使用 yarn + yarn lint + ``` + +## 目录结构 + +``` +vit-elment/ +├── public/ # 静态资源目录 +├── src/ # 源代码目录 +│ ├── assets/ # 项目资源文件 +│ ├── components/ # 公共组件 +│ ├── router/ # 路由配置 +│ ├── views/ # 页面组件 +│ ├── App.vue # 根组件 +│ └── main.ts # 入口文件 +├── .gitignore # Git 忽略文件配置 +└── package.json # 项目配置文件 +``` + +## 贡献指南 + +欢迎贡献代码和提出建议!请遵循以下步骤: +1. Fork 项目仓库 +2. 创建新分支 (`git checkout -b feature/new-feature`) +3. 提交更改 (`git commit -m 'Add new feature'`) +4. 推送分支 (`git push origin feature/new-feature`) +5. 提交 Pull Request + +## 许可证 + +本项目采用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。 \ No newline at end of file