学习课程名称:从零做一个前端开源项目
章节名称:开发环境
讲师:双越
课程内容:搭建开发环境
初始化
进入项目目录,然后命令行运行 npm init ,按照提示进行初始化即可。提示中的信息,能写上的都写上,别随意忽略了。初始化完成之后,项目根目录下会有package.json 的文件。
规范版本号
打开package.json 文件,将版本号定义为"version" : “0.0.1”。以后我们每次正式提交代码,版本号都不一样。版本号分三级,分别为:
- 一级,重构版本
- 二级,重大功能改进
- 三级,小升级或者bug修复
为何从 0.0.1 开始?因为0.x.x 可以认为是非正式版本,测试版,而从1.x.x开始,就是正式发布的版本了。
规范一级目录
项目的一级目录要提前规范好,最起码一些常用的目录要提前订好留用,不能乱来。例如:
- src-源代码
- release - 发布结果
- test - 单元测试用例
- doc - 文档
- expample - 示例
构建工具
这部分比较独立,内容比较多,用最常用的webpack做一个简单的演示。
安装插件 npm i babel-core babel-loader babel-polyfill babel-preset-es2015 babel-preset-latest webpack webpack-cli --save-dev
项目根目录下创建.babelrc文件
项目根目录创建webpack.config.js文件
最后,修改package.json 中的 scripts,增加"release":“webpack”。然后命令行运行npm run release , 就可以生成release的内容。
运行示例
release的内容已经发布出来了,还要运行起来,最简单的方式,在example创建test.html,然后引用 release 的内容。
规范git 分支
至少要存在两个分支,master 和 dev, dev是开发中的代码。当然,你可以规范更多的分支,例如 next fix-bug等,但是注意一个原则 – 用不到的就先不要规划。
完善README.md
README.md 是开源项目的一张脸,用户的第一印象。必须包含一下内容:
- 产品简介(此处要突出特点,打差异化竞争)
- 产品安装和下载
- 快速使用(详细的使用文档或者二次开发文档,外链即可)
- 交流问答区
- 关于作者(放你的博客链接,和收款二维码)