Wang's blog Wang's blog
首页
  • 前端文章

    • HTML教程
    • CSS
    • JavaScript
  • 前端框架

    • Vue
    • React
    • VuePress
    • Electron
  • 后端技术

    • Npm
    • Node
    • TypeScript
  • 编程规范

    • 规范
  • 我的笔记
  • Git
  • GitHub
  • VSCode
  • Mac工具
  • 数据库
  • Google
  • 服务器
  • Python爬虫
  • 前端教程
更多
收藏
关于
  • 分类
  • 标签
  • 归档
GitHub (opens new window)

Wang Mings

跟随大神,成为大神!
首页
  • 前端文章

    • HTML教程
    • CSS
    • JavaScript
  • 前端框架

    • Vue
    • React
    • VuePress
    • Electron
  • 后端技术

    • Npm
    • Node
    • TypeScript
  • 编程规范

    • 规范
  • 我的笔记
  • Git
  • GitHub
  • VSCode
  • Mac工具
  • 数据库
  • Google
  • 服务器
  • Python爬虫
  • 前端教程
更多
收藏
关于
  • 分类
  • 标签
  • 归档
GitHub (opens new window)
  • CSS

  • Npm

  • Vue

  • HTML

  • Node

  • Yaml

  • React

  • 框架

  • 规范

    • 模板
    • JS规范
    • CSS规范
    • html规范
    • ESLint规范
    • readme文件
      • 模板下载:
      • 1. 运行命令
      • 2. 部署方式
      • 3. 接口文档链接
      • 4. 开发过程中可能会遇到的坑
      • 5. 版本管理
        • 设计稿文档链接
        • 需求文档链接
      • 6. 线上访问地址
    • 命名规范
    • Git操作规范
    • 测试与发布
    • stylelint配置使用
    • Typescript错误忽略
  • Electron

  • JS演示

  • VuePress

  • JavaScript

  • TypeScript

  • 微信小程序

  • TypeScript-axios

  • 前端
  • 规范
wangmings
2022-07-19
目录

readme文件

# readme 文件

readme 中需要列出以下内容:

# 模板下载:readme.md

# 1. 运行命令

列出如何运行当前项目的命令,如:

# 安装依赖
npm install

# 启动项目
npm run dev
1
2
3
4
5

# 2. 部署方式

列出如何部署当前项目的命令,如:

# 部署到测试环境
npm run publish:qa

# 部署到生产环境
npm run publish:prod
1
2
3
4
5

# 3. 接口文档链接

列出当前项目接口文档的链接,如:

  • 接口文档链接:https://za13.w.eolinker.com/#/share/index?shareCode=RWbEl9 (opens new window)
  • 密码:****

# 4. 开发过程中可能会遇到的坑

大致写一下开发当前项目过程中可能会遇到的问题,以及解决办法

# 5. 版本管理

列出当前项目所有版本的设计稿文档链接和需求文档链接

# 设计稿文档链接

如:

  • 2.1 设计稿 (opens new window)

# 需求文档链接

如:

  • 2.2 需求文档 (opens new window)

# 6. 线上访问地址

如:

  • 线上访问地址:http://fe1.comliq.net/standard/ (opens new window)
编辑 (opens new window)
ESLint规范
命名规范

← ESLint规范 命名规范→

最近更新
01
theme-vdoing-blog博客静态编译问题
09-16
02
搜索引擎
07-19
03
友情链接
07-19
更多文章>
Theme by Vdoing | Copyright © 2019-2022 Evan Xu | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式