readme文件
# readme 文件
readme 中需要列出以下内容:
# 模板下载:readme.md
# 1. 运行命令
列出如何运行当前项目的命令,如:
# 安装依赖
npm install
# 启动项目
npm run dev
1
2
3
4
5
2
3
4
5
# 2. 部署方式
列出如何部署当前项目的命令,如:
# 部署到测试环境
npm run publish:qa
# 部署到生产环境
npm run publish:prod
1
2
3
4
5
2
3
4
5
# 3. 接口文档链接
列出当前项目接口文档的链接,如:
# 4. 开发过程中可能会遇到的坑
大致写一下开发当前项目过程中可能会遇到的问题,以及解决办法
# 5. 版本管理
列出当前项目所有版本的设计稿文档链接和需求文档链接
# 设计稿文档链接
如:
# 需求文档链接
如:
# 6. 线上访问地址
如:
编辑 (opens new window)