common-website

你身边的快速开发框架

基于 Nodejs & Bootstrap & mysql 的快速开发框架

bootstrap负责UI展示，nodejs用于后台请求处理，数据存储到mysql

概述

用最少的代码处理更多的事情。

基于nodejs的后台对express进行了封装，将filter，handler，controller拆分成组件形式。通过framework.js对相应目录进行扫描实现动态加载。

前端采用标准bootstrap框架，对表单进行了拆分、重构及封装，可通过定制表单结构自动生成增删改查等简单操作，亦可根据业务需求实现自定义表单内容及处理流程。

备注：

http://domain:3000/apis 当前框架已加载的controll（包括名称、描述、权限）
http://domain:3000/ blog类UI
http://domain:3000/admin/ 管理系统或后台类UI
http://domain:3000/chat/ 基于socket.io的即时通讯开发示例

安装 & 部署

依赖关系

Nodejs
MySQL

安装

进入common-website根目录
初始化nodejs依赖包 npm install

部署

进入common-website根目录
执行启动命令 npm start

更新日志

v0.0.1 2017年6月10日 18:25 初次建库

动态表单生成，并支持自定义表单
定义常规控件及表单样式
集成文件上传组件
集成权限管理、用户管理、角色管理模块
集成日志记录及查询模块
集成参数设置及数据字典管理模块
集成即使通讯模块
集成百度ECharts图标控件

示例

一、 Controller 定义

module.exports = {
  // API根目录
  "rootpath": "/api/school/",
  // API定义 default为默认根目录
  "mapping": {
    "default": { "description": "获取学校列表" },
    "insert": { "description": "新增学校" },
    "update": { "description": "修改学校" },
    "delete": { "description": "删除学校" }
  },
  // 数据模型定义
  "entity": {
    // 数据表名称
    "table": "object_school",
    // 数据表对应字段名称、数据类型定义
    "columns": [
      { "name": "id", "primary": true },
      { "name": "name", "base64": true, "requid": true, "filter": "like" },
      { "name": "type", "filter": "multiple", "requid": true },
      { "name": "addr", "base64": true, "requid": true, "filter": "like" },
      { "name": "telphone", "filter": "like" },
      { "name": "describe", "base64": true, "filter": true },
      { "name": "jointime", "filter": "daterange" },
      { "name": "imgs" }
    ]
  }
}

// entity.column 介绍
// name           数据表对应的字段名称
// primary        是否为数据表主键，用于增删改操作，记录操作日志时也会用到
// base64         标示数据项在传输过程中是否采用base64加密
// filter         当数据项作为查询条件时的处理方式 枚举值
//    mulitple    多数值匹配类型，常用于字典表
//    like        模糊查询
//    daterange   日期时间段
//    true        标示数据项在查询时作为筛选条件
// requid         标示数据项在新增和修改时为必填项
// unique         标示数据项唯一
// default        方法类型,为数据项设置默认值
//    function(req,res){return string}

Common API

暂无描述

API Request & Response

操作成功

{
  // 操作结果 0表示成功；0其他为失败
  "c":0,
  // 返回的数据
  "data":{
    // 分页数据专有：页面大小
    "pagesize":6,
    // 分页数据专有：页面总数
    "pagecount":2,
    // 分页数据专有：记录总数
    "recordcount":7,
    // 分页数据专有：当前页码
    "pagenumber":1,
    // 列表数据专有：表示数据列表
    "list":[]
  }
}

操作失败

{
  // 操作结果
  "c":1,
  // 错误消息描述：采用base64加密
  "m":"55So5oi35ZCN5oiW5a+G56CB5LiN5q2j56Gu",
  // 调试模式专有：未加密错误描述
  "zh_cn":"用户名或密码不正确"
}

路由列表 | Routes List

用户鉴权 | api/account
活动管理 | api/activity
动态管理 | api/article
字典管理 | api/dict
日志管理 | api/logs
机构管理 | api/organization
学校管理 | api/school
角色管理 | api/roles
参数设置 | api/settings
用户管理 | api/users
评论插件 | api/comment
环境变量 | api/environment
文件列表 | api/files
文件修改 | api/files/update [未完成]
文件删除 | api/files/delete [未完成]
文件上传 | api/upload
获取文件 | /file

用户鉴权 | api/account

主要功能为实现用户登录及用户注销,并且给于响应的session验证及权限验证.

方法列表

用户登录
用户注销
修改用户密码
修改用户信息

1.用户登录 | login

参数说明

序号	类型	描述
u	string	登录账号
p	string	登录密码

示例代码

// /api/account/login?u=d2FuZ3hpbg%3D%3D&p=MTIzNDU2
{
  "c":0,
  "data":{
    "account":"d2FuZ3hpbg==",
    "name":"546L6ZGr",
    "nickname":"5bCP5LyN",
    "email":"YWRtaW5fc21hbGxAMTYzLmNvbQ==",
    "rolename":"57O757uf566h55CG5ZGY",
    "list":[
      "101",
      "102"
    ]
  }
}

2.用户注销 | logout

示例代码

// /api/account/logout
{"c":0}

3.修改用户密码 | changepwd

参数说明

参数	类型	描述	必填项	加密及方式
u	string	登录账号	必填	base64加密
p	string	登录原始密码	必填	md5base64加密
n	string	登录新密码	必填	md5base64加密

示例代码

// /api/account/changepwd?n=MTIz&p=MTIzNDU2
{"c":0}

4.修改用户信息 | changeinfo

参数说明

参数	类型	描述	必填项	加密及方式
user	string	登录账号	必填	base64加密
username	string	用户名称	必填	base64加密
nickname	string	用户昵称	必填	base64加密
email	string	Email	必填

示例代码

// /api/account/changeinfo
{"c":0}

/api/account/regist

新用户注册

/api/account/forgot

用户找回密码请求

/api/account/reset

用户重置密码

/api/environment/ 需要权限验证

获取系统运行环境

/api/activity/ 需要权限验证

通过查询条件筛选，返回经过分页处理的活动列表。

参数	类型	描述	必填项	加密及方式
id	string	编号	可选
name	string	活动名称	可选	base64 加密
price	string	报名费用	可选
describe	string	活动介绍	可选	base64 加密
endtime	string	结束时间	可选
begintime	string	开始时间	可选
imgs	string	图片列表	可选
person	string	成人数量	可选
children	string	孩子数量	可选
type	string	活动类型	可选
sender	string	活动发起者	可选
sendertype	string	发起者类型	可选

/api/activity/add 需要权限验证

新增一个活动

/api/activity/update 需要权限验证

修改活动详细信息

/api/activity/delete 需要权限验证

删除一个活动

参数	类型	描述	必填项	加密及方式
id	string	编号	必填

/api/article/ 需要权限验证

获取动态列表

/api/comment/ 需要权限验证

获取评论列表

/api/comment/add 需要权限验证

/api/comment/delete 需要权限验证

根据评论编号,删除一条评论.

/api/comment/user 需要权限验证

根据用户编号获取该用户的全部评论

/api/organization/ 需要权限验证

获取培训机构列表

参数	类型	必填项	加密及方式
id	string	可选
name	string	可选	base64 加密
type	string	可选
addr	string	可选	base64 加密
telphone	string	可选
describe	string	可选	base64 加密
jointime	string	可选
imgs	string	可选

/api/organization/add 需要权限验证

新增培训机构

/api/organization/update 需要权限验证

修改培训机构

/api/organization/delete 需要权限验证

删除培训机构

参数|类型|描述|必填项|加密及方式

:----|:-----:|-----:|-----:|-----:

id|string||必填|

/api/school/ 需要权限验证

获取学校列表

参数	类型	必填项	加密及方式
id	string	可选
name	string	可选	base64 加密
type	string	可选
addr	string	可选	base64 加密
telphone	string	可选
describe	string	可选	base64 加密
jointime	string	可选
imgs	string	可选

/api/school/add 需要权限验证

新增学校

/api/school/update 需要权限验证

修改学校

/api/school/delete 需要权限验证

删除学校

参数	类型	描述	必填项	加密及方式
id	string		必填

/api/dict/ 需要权限验证

获取字典数据列表

参数	类型	必填项	加密及方式
dictkey	string	可选
itemkey	string	可选
itemvalue	string	可选	base64 加密

/api/dict/all 需要权限验证

获取全部字典数据列表

/api/dict/add 需要权限验证

新增字典数据

/api/dict/update 需要权限验证

修改字典数据

/api/dict/delete 需要权限验证

删除字典数据

参数	类型	描述	必填项	加密及方式
dictkey	string		必填
itemkey	string		必填

/api/files 需要权限验证

获取用户拥有的文件列表

/api/upload 需要权限验证

文件上传

/file

根据编号获取文件

/api/files/update 需要权限验证

修改文件信息

/api/files/delete 需要权限验证

删除文件

参数	类型	描述	必填项	加密及方式
id	string		必填

/api/settings/ 需要权限验证

获取全部参数信息

/api/settings/read 需要权限验证

获取设置信息

/api/settings/save 需要权限验证

保存设置信息

/api/ecr/login

获取活动列表

/api/ecr/rolelist

/api/logs/ 需要权限验证

获取日志列表

参数	类型	必填项	加密及方式
id	string	可选
date	string	可选
owner	string	可选	base64 加密
ip	string	可选	base64 加密
type	string	可选
msg	string	可选	base64 加密

/api/logs/types 需要权限验证

获取日志类型类表

/api/roles/ 需要权限验证

获取角色列表

参数	类型	必填项	加密及方式
id	string	可选
name	string	可选	base64 加密
funcids	string	可选

/api/roles/all

获取全部角色列表

/api/roles/add 需要权限验证

新增角色

参数	类型	必填项	加密及方式
id	string	必填
name	string	必填	base64 加密
funcids	string	必填

/api/roles/update 需要权限验证

修改角色

参数	类型	必填项	加密及方式
id	string	必填
name	string	必填	base64 加密
funcids	string	必填

/api/roles/delete 需要权限验证

删除角色

参数	类型	必填项	加密及方式
id	string	必填
name	string	必填	base64 加密
funcids	string	必填

参数	类型	描述	必填项	加密及方式
id	string		必填

/api/users/ 需要权限验证

获取用户列表

/api/users/add 需要权限验证

新增用户

参数	类型	必填项	加密及方式
id	string	必填
name	string	必填	base64 加密
nickname	string	必填	base64 加密
roleid	string	必填
account	string	必填	base64 加密
email	string	可选	base64 加密
password	string	可选

/api/users/update 需要权限验证

修改用户

参数	类型	必填项	加密及方式
id	string	必填
name	string	必填	base64 加密
nickname	string	必填	base64 加密
roleid	string	必填
account	string	必填	base64 加密
email	string	可选	base64 加密
password	string	可选

/api/users/delete 需要权限验证

删除用户

参数	类型	描述	必填项	加密及方式
id	string		必填

/api/users/info 需要权限验证

查看用户详细信息

Name		Name	Last commit message	Last commit date
Latest commit History 20 Commits
.vscode		.vscode
app		app
lib		lib
public		public
views		views
.DS_Store		.DS_Store
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
config.js		config.js
package-lock.json		package-lock.json
package.json		package.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

common-website

基于 Nodejs & Bootstrap & mysql 的快速开发框架

概述

安装 & 部署

依赖关系

安装

部署

更新日志

v0.0.1 2017年6月10日 18:25 初次建库

示例

一、 Controller 定义

Common API

API Request & Response

路由列表 | Routes List

用户鉴权 | api/account

1.用户登录 | login

参数说明

示例代码

2.用户注销 | logout

示例代码

3.修改用户密码 | changepwd

参数说明

示例代码

4.修改用户信息 | changeinfo

参数说明

示例代码

About

Releases

Packages

Languages

License

baby-plan/common-website

Folders and files

Latest commit

History

Repository files navigation

common-website

基于 Nodejs & Bootstrap & mysql 的快速开发框架

概述

安装 & 部署

依赖关系

安装

部署

更新日志

v0.0.1 2017年6月10日 18:25 初次建库

示例

一、 Controller 定义

Common API

API Request & Response

路由列表 | Routes List

用户鉴权 | api/account

1.用户登录 | login

参数说明

示例代码

2.用户注销 | logout

示例代码

3.修改用户密码 | changepwd

参数说明

示例代码

4.修改用户信息 | changeinfo

参数说明

示例代码

About

Topics

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages