项目文档说明前端部分怎么写？写进readme.md文件里面。

接口文档示例

一、环境及版本说明

vue 版本 2.6.10
element-ui 版本 2.13.0
node版本12.14.1

二、开发相关环境及配置

2.1项目资料

2.1.1接口地址

正式接口地址：https://

测试接口地址:https://

2.1.2文档地址

接口文档:http://

需求文档:

设计文档:

2.1.3 UI&UX地址

原型图地址:http:// [负责人:]

UI切图地址: [负责人:]

2.2项目配置

2.2.1安装node环境

2.2.2项目安装

npm install

2.2.3 项目编译&热加载【开发模式】（Compiles and hot-reloads for development）

npm run dev

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

三、项目部署

3.2.1安装node环境

3.2.2项目安装

npm install

3.2.3 设置线上接口地址

项目根目录下libs/http.js下第四行，代码如下所示

let base = ''

把测试接口地址 https:// 改成正式地址如 https://

3.2.4 项目编译最小静态文件【生产模式】（Compiles and minifies for production）

npm run build

3.2.5 压缩拷贝项目根目录下dist文件放到服务器项目根目录解压

四、代码及代码目录结构及代码文件功能说明

4.1插件说明

前端使用vue-cli构建项目
使用axios发送请求

4.2代码结构说明

dist 发布打包后静态文件目录
node_modules node模块安装目录
public 公共目录
- favicon.ico 网站头部左边图片;
- Index.html webpack打包页面模板;
Src 开发的目录
assets 项目静态文件目录
- del.png 新增编辑消息删除图标
libs 接口调用目录
- api.js 接口调用配置
- http.js axios配置
router 路由文件目录
- index.js 路由配置
views 页面目录
- components 组件文件
  - addDialog.vue 消息新增编辑页面
  - sendNews.vue 发送消息页面
- messageCenter.vue 首页表格页面
app.vue 项目入口文件
main.js 项目核心文件
.gitignore 忽略编译生成的中间文件
babel.config.js babel配置文件
package-lock.json 模块与模块之间的依赖关系文件
package.json 项目描述文件
README.md 项目说明文档

项目文档说明前端部分怎么写？写进readme.md文件里面。相关推荐

权限管理系统项目文档——Vue前端
文章目录第二篇前端实现篇 1. 搭建开发环境 1.1 技术基础 1.2 开发环境 1.3 创建项目 2. 前端项目案例 2.1 安装Element 2.2 页面路由 2.3 安装SCSS 2.4 ...
如何写一个好的Github项目文档
一.什么是Github? Github是通过Git进行版本控制的软件源代码托管服务平台. Github除了Git代码仓库托管及基本的Web管理界面以外,它还提供了一些方便社会化共同软件开发的功能,即一 ...
秒建炫酷的开源项目文档，这款神器用起来够优雅
学习过我的开源项目mall的朋友应该知道,我有一个使用Docsify 搭建的项目文档网站.使用Docsify搭建文档网站虽然简单,但是缺少分类.标签.SEO这类功能,随着文档越来越多,查找起来有点不方 ...
网上音乐商店项目文档
超低配版ssm项目第一次写项目文档,非常地不成熟,格式都是随心所欲的... 分享记录一下项目文档文章目录项目文档一.需求分析 1.客户 2.游客 3.管理员二.技术选型三.数据库表设计( ...
部署springboot+vue项目文档（若依ruoyi项目部署步骤）
部署springboot+vue项目文档(若依ruoyi项目部署步骤) 一:部署linux + nginx 二:部署windows + tomcat(无nginx) 三:解决调用第三方api如百度地图 ...
java对office、pdf文档在线预览解析（融合进项目中）
最近在项目中要做一个文档的预览,在网上搜了好多demo,都可以实现其功能,但是放在自己的项目中有点复杂. 先说明本人的开发环境(win7+tomcat7+maven+svn+myeclipse),接下 ...
showDoc项目文档管理工具
ShowDoc是什么每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂.文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却 ...
README 规范和项目文档规范
1. README 规范我们直接通过一个 README 模板,来看一下 README 规范中的内容: # 项目名称## 功能特性<!-- 描 ...
【深入浅出项目管理视频1】-项目文档评审
决定尝试用视频的方式来表达这些繁琐的内容, 比写长篇大论可能更直观些,这是我们产品中实现的项目文档评审过程,与大家分享: 不小心录的视频有些大,得有1280宽的显示器才能看完整,也不知道视频在cnbl ...
项目文档管理的一些想法
我个人比较倾向于敏捷的方式,不赞同大而全的文档,因为那样的文档书写起来浪费时间,维护起来更浪费时间,更可怕的是没有持续更新导致文档与实际项目偏差很大的文档.所以我认为文档就是应该少而精,必须确保文档的 ...

项目文档说明前端部分怎么写？写进readme.md文件里面。

接口文档示例

一、环境及版本说明

二、开发相关环境及配置

2.1项目资料

2.1.1接口地址

2.1.2文档地址

2.1.3 UI&UX地址

2.2项目配置

2.2.1安装node环境

2.2.2项目安装

2.2.3 项目编译&热加载【开发模式】（Compiles and hot-reloads for development）

Compiles and minifies for production

Lints and fixes files

三、项目部署

3.2.1安装node环境

3.2.2项目安装

3.2.3 设置线上接口地址

3.2.4 项目编译最小静态文件【生产模式】（Compiles and minifies for production）

3.2.5 压缩拷贝项目根目录下dist文件放到服务器项目根目录解压

四、代码及代码目录结构及代码文件功能说明

4.1插件说明

4.2代码结构说明

项目文档说明前端部分怎么写？写进readme.md文件里面。相关推荐

最新文章

热门文章