项目地址
为什么要写 bee-koa-cli
- 有时候看某些技术群里的小伙伴聊天,发现很多同学对后端的知识比较匮乏.故此想写个项目,实现下最基本的增删改查登录权限的功能,让小伙伴们跟着生成的项目模板一点点的写出自己的完整逻辑的接口.
- 有时候就需要mock功能,或者模拟线上API环境调试等,能快速生成个后端项目就很方便.
如何使用
-
可以全局安装:
npm install bee-koa-cli -g.
然后koa create product-name或者koa-cli create product-name或者bee-koa-cli create product-name. (没错,注册了三个命令😶) -
当然,也可以npx创建项目,
npx bee-koa-cli create product-name. -
通过命令行指示,选择对应的数据库后,会生成koa代码的项目目录.
- 进入项目后根据
README.md提示创建数据库:
CREATE DATABASE dataname DEFAULT CHARACTER SET utf8 COLLATE utf8_general_
ci;
- 进入
src/conf/secretKeys.js,设置正确的本地mysql连接密码. - 执行命令
npm run sync:force,更新数据库表和字段内容. - 最后就可以
npm i和npm run dev开启服务啦. 🎉🎉🎉🎉🎉🎉
集成的功能
- 数据库表字段的schema模型,外键,同步表信息等功能.
- 路由/控制器/model的文件分层.
- 配置数据库/密钥/环境变量等配置文件.
- 用户的注册/登录/查询登录信息.
- 文件上传.
- 热更新.
用到了哪些包?
koa-jwt,jsonwebtoken实现JWT登录状态.koa-bodyparser,koa-parameter接口请求的参数解析.formidable-upload-koa文件上传.mysql2,sequelize操作数据库.cross-env设置环境变量.nodemon热更新.
最后
希望我写的这个简单轻量的工具能帮助到你.
