快速体验

大概步骤

准备环境 - 下载模板 - 修改配置 - 同步库表 - 运行程序

🔥 运行环境

这个不多说，不会的请查资料或联系作者微信 chensuiyime 进行指导。

1. 请准备好 nodejs 环境，版本 v20+
   1. 请准备好 pnpm 包管理工具。
   2. 请准备好 nodemon 开发环境启动和监控工具。
2. 请准备好 mysql 环境，版本 v5.7+
   1. 可以使用 phpenv 集成环境启用 mysql。
3. 请准备好 redis 环境，版本 v5+
   1. windows 版本下载地址点击下载

🔥 开发准备

✅ 安装 pnpm 包管理器

本项目建议使用 pnpm 作为 nodejs 包管理工具，版本不低于 v7+。

如未安装，请使用如下命令全局安装。

npm install -g pnpm

✅ 安装 dloo 模板下载工具

npm install -g dloo

✅ 下载 funpiba 接口开发模板

如果你使用的是 npm：

npx dloo -t funpiba

如果你使用的是 pnpm：

pnpm dlx dloo -t funpiba

下载流程如下图。

D:\codes\chensuiyi\dloo>node dloo.js -t funpiba
ℹ 开发者：陈随易（https://chensuiyi.me）
-----------------------------------------
ℹ funpiba 接口项目开发模板下载中...
✔ 资源已下载到默认的 .dloo 目录，请移动到正确的目录!

注意

关于 funpi 和 funpiba 的关系：

funpi 相当于前端界的 vue.js，是一个接口 开发框架。

funpiba 相当于一个封装好了 vue.js 的项目 开发模板。

下载完毕后，执行 pnpm install 命令，安装项目依赖。

🔥 配置参数

📄 /env.js 文件

注意：请确保数据库中已经存在 db 属性对应的数据库名称，如没有，请先创建对应的数据库。

export const envConfig = {
    development: {
        NODE_ENV: 'development',
        // mysql 配置
        MYSQL_HOST: '127.0.0.1',
        MYSQL_DB: 'funpi_demo',
        MYSQL_USERNAME: 'root',
        MYSQL_PASSWORD: 'root',
        // redis 配置
        REDIS_PASSWORD: '',
        // 上传配置
        LOCAL_DIR: './public/static',
        // 微信配置
        PAY_NOTIFY_URL: ''
    },
    production: {
        NODE_ENV: 'production',
        // mysql 配置
        MYSQL_HOST: '10.0.4.6',
        MYSQL_DB: 'funpi_demo',
        MYSQL_USERNAME: 'funpi_demo',
        MYSQL_PASSWORD: 'funpi_demo',
        // redis 配置
        REDIS_PASSWORD: 'b6goahkuwd3r883fj8t7',
        // 上传配置
        LOCAL_DIR: './public/static',
        // 微信配置
        PAY_NOTIFY_URL: ''
    }
}[process.env.NODE_ENV];

🔥 执行脚本

pnpm run syncMysql:dev

使用以上命令，创建和同步数据库，表，字段。

√ 所有表定义正常
√ sys_admin(系统管理员表) 字段无改动
√ sys_admin_action_log(管理员操作日志表) 空表已创建
√ sys_admin_login_log(管理员登录日志表) 字段无改动
√ sys_api(系统接口表) 字段无改动
√ sys_dict(字典数据表) 字段无改动
√ sys_dict_category(字典分类表) 字段无改动
√ sys_mail_log(邮件日志表) 字段无改动
√ sys_menu(系统菜单表) 字段无改动
√ sys_role(系统角色表) 字段无改动
√ example(新闻示例表) 字段无改动
√ funpi_demo 数据库表同步成功

执行效果如上。

🔥 启动项目

执行 pnpm run dev 运行接口服务。

浏览器访问 http://127.0.0.1:3000。

接口启动成功信息。

在浏览器输入 http://127.0.0.1:3000/swagger 回车，就能看到接口文档。

端口号根据自己的配置来。