diff --git a/README.md b/README.md index 8b2223bc2abe4e3011742b722b9c5939c40810c8..252f76c0ab1a4078fefc83db948754ae7596f0a7 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,52 @@ -# webpack-react-cli - -#### 介绍 -使用webpack搭建react+less+antd项目模板 - -#### 软件架构 -软件架构说明 - -#### 安装教程 - -1. xxxx -2. xxxx -3. xxxx - -#### 使用说明 - -1. xxxx -2. xxxx -3. xxxx - -#### 参与贡献 - -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - - -#### 特技 - -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +# webpack-react-cli + +## 介绍 +`webpack-react-cli` 是一个基于 Webpack 构建的项目模板,适用于开发 React 应用,集成 Less 和 Ant Design,帮助开发者快速启动项目。 + +## 软件架构 +该项目基于 Webpack 构建系统,使用 Babel 编译 JavaScript,支持 React、Less 和 Ant Design。项目结构清晰,包含开发和生产环境的 Webpack 配置,同时集成了 ESLint 用于代码规范。 + +## 安装教程 +1. 克隆仓库: + ```bash + git clone https://gitee.com/lhl4529/webpack-react-cli.git + ``` +2. 进入项目目录: + ```bash + cd webpack-react-cli + ``` +3. 安装依赖: + ```bash + npm install 或 pnpm install + ``` + +## 使用说明 +1. 启动开发服务器: + ```bash + npm start 或 pnpm start + ``` +2. 构建生产环境代码: + ```bash + npm run build 或 pnpm build + ``` + +## 项目结构 +- `config/webpack.config.dev.js` 和 `config/webpack.config.prod.js`:开发和生产环境的 Webpack 配置文件。 +- `src/main.js`:项目的入口文件。 +- `src/app.jsx`:主 React 组件。 +- `src/pages/`:存放页面组件,如 `Home` 和 `About`。 +- `public/index.html`:HTML 模板文件,包含用于渲染 React 应用的 `div#app`。 + +## 参与贡献 +1. Fork 本仓库。 +2. 新建 Feat_xxx 分支。 +3. 提交代码。 +4. 新建 Pull Request。 + +## 特技 +1. 使用 `Readme_XXX.md` 来支持不同的语言,例如 `Readme_en.md`, `Readme_zh.md`。 +2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)。 +3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目。 +4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目。 +5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)。 +6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)。 \ No newline at end of file