记账本后端代码（node.js）

<!-- * @Author: Huangxianlong * @Date: 2023-07-17 10:31:41 * @LastEditors: Huangxianlong * @LastEditTime: 2023-07-28 14:12:28 * @FilePath: \cashbook-server\README.md * @Description: --> # cashbook-server ## 项目介绍 cashbook-server 是记账本的后端项目，采用 node.js 来开发，框架使用了 egg 框架。 ### egg 参考文档 see [egg docs](https://www.eggjs.org/) for more detail. ## 项目架构 ``` ┌─ app | ├─ controller 接口控制器 | ├─ middleware 中间件 | ├─ public 静态资源 | ├─ service 接口服务 | ├─ view 项目页面 | ├─ router.js 接口路由配置文件 ├─ config 项目配置 ├─ logs 项目日志 ├─ package.json 包管理文件 ├─ README.md 项目说明文件 ``` ## 环境要求 - Node 环境 版本：16+ - 开发工具 VSCode ## 项目预览 前后端项目目前已经部署到线上环境，大家可以通过以下地址进行访问： **「记账本」在线预览：** http://114.115.145.217:8003/ > 测试账号：admin，测试密码：123456 也可以自行注册使用。 **「记账本」前端代码开源地址：** https://gitee.com/Huangxianlong11/cashbook-vue3-h5 **「记账本」后端代码开源地址：** https://gitee.com/Huangxianlong11/cashbook-server ## 安装使用 ### 开发环境 #### 安装依赖 ```bash $ npm i ``` #### 运行 ```bash $ npm run dev ``` #### 调用地址 ```bash $ open http://localhost:7001/ ``` ### 生产环境 #### 运行 ```bash $ npm start ``` #### 停止 ```bash $ npm stop ``` ## 数据库设计 记账本主要分为三个模块，分别为用户模块、账单模块和账单类型模块，三个模块分别设计了三个数据表来存储数据。 - 用户模块——设计用户表 user - id：自增主键; - username：用于存储用户登录名称; - password：用于存储用户登录密码; - signature：用于存储用户个性签名; - avatar：用于存储用户头像信息; - ctime：用于存储用户创建时间字段。 - 账单模块——设计账单表 bill - id：主键; - pay_type：账单类型（1 为支出，2 为收入）; - amount：账单价格; - date：账单日期（以时间戳的形式存储）; - type_id：账单标签 id（如：餐饮、交通、日用、学习、购物等）; - type_name：账单标签名称（如：餐饮、交通、日用、学习、购物等）; - user_id：账单归属的用户 id; - remark：账单备注。 - 账单类型模块——设计账单类型表 type - id：主键; - name：类型名称，如餐饮、交通、日用、学习、购物等; - type：类型类型（1 为支出，2 为收入）; - icon：类型图标 class 名，如 icon-meishi; - user_id：默认 0 为全部用户可见，某个用户单独设置的类型，user_id 就是该用户的用户 id，在获取列表的时候，方便过滤。 ## Git 贡献提交规范 参考 vue 规范 - feat 增加新功能 - fix 修复问题/BUG - style 代码风格相关无影响运行结果的 - perf 优化/性能提升 - refactor 重构 - revert 撤销修改 - test 测试相关 - docs 文档/注释 - chore 依赖更新/脚手架配置修改等 - workflow 工作流改进 - ci 持续集成 - types 类型定义文件更改 - wip 开发中 ## npm scripts - Use `npm run lint` to check code style. - Use `npm test` to run unit test. - Use `npm run autod` to auto detect dependencies upgrade, see [autod](https://www.npmjs.com/package/autod) for more detail. [egg]: https://eggjs.org