README.md文件模板-普通小型项目

Admin 2020-05-29 AM 7066℃ 0条

项目名称

项目简介

项目定位

项目特点

软件功能

版本信息

效果图

安装说明

环境依赖

node v0.10.28+

redIs ~

部署安装

添加系统环境变量

export $PORTAL_VERSION="production" // production, test, dev
npm install //安装node运行环境
gulp build //前端编译
启动两个配置(已forever为例)
eg: forever start app-service.js
```
forever start logger-service.js
```

使用说明

简要说明

具体说明

目录结构

├── Readme.md                   // help
├── app                         // 应用
├── config                      // 配置
│   ├── default.json
│   ├── dev.json                // 开发环境
│   ├── experiment.json         // 实验
│   ├── index.js                // 配置控制
│   ├── local.json              // 本地
│   ├── production.json         // 生产环境
│   └── test.json               // 测试环境
├── data
├── doc                         // 文档
├── environment
├── gulpfile.js
├── locales
├── logger-service.js           // 启动日志配置
├── node_modules
├── package.json
├── app-service.js              // 启动应用配置
├── static                      // web静态资源加载
│   └── initjson
│       └── config.js         // 提供给前端的配置
├── test
├── test-service.js
└── tools