NocoBase 开发环境搭建实战：从源码跑通到热更新调好

NocoBase 开发环境搭建实战从源码跑通到热更新调好【免费下载链接】nocobaseNocoBase is an open-source AI no-code platform for building business systems fast. Instead of generating everything from scratch, AI works on top of production-proven infrastructure and a WYSIWYG no-code interface, so you get both speed and reliability.项目地址: https://gitcode.com/GitHub_Trending/no/nocobaseNocoBase 开发环境搭建的核心其实就是两件事从源码跑起最小示例再让完整 monorepo 的热更新转起来。假如你想写一个自定义插件、改完代码立刻看到效果打开终端跟着这篇文章敲命令就行。 5 分钟跑通最小开发环境目标只有一个让终端不再神秘。先不碰完整应用我们把最小示例跑起来看到 API 真实返回数据你对项目的感觉就有了。先拉代码并安装全部依赖git clone https://gitcode.com/GitHub_Trending/no/nocobase cd nocobase yarn install第二条命令比看起来重NocoBase 是 monorepoyarn install会顺带执行postinstall把packages/下所有本地包互相关联进node_modules首次跑需要几分钟。代码主要分两块packages/core/放 server、database、权限控制ACL访问控制列表等核心件packages/plugins/放全部功能插件。示例不依赖这两块的编译产物所以启动飞快——这也是我们先用示例热身的原因。 提示安装跑到一半别按 CtrlC关联阶段中断是后面各种玄学报错的常见来源。版本要求看这张表不用纠结太多项目推荐值为什么Node.js20.x项目锁定 20.16package.json声明18但volta字段锁定 20.16.0跟锁走最稳yarn1.22项目用 yarn 1 classicpackageManager字段已固定数据库SQLite零配置示例默认即可运行之后要切换数据库方言再改然后启动最小示例并用一个请求验证yarn run:example app/single-app start # 启动完成后另开一个终端执行 curl http://localhost:13000/api/test:list第一条命令跑的是 examples/app/single-app.ts一个最精简的Application实例只注册了一个test资源。第二条命令用来验证接口活着看到返回test list环境就算通了。按需深入三件你大概率要做的事改完代码用热更新立刻看到效果动核心代码或写插件真正的插件开发配置场景就用 monorepo 的开发模式yarn dev # 前后端一起改动即热更 yarn dev-server # 只起后端适合调 APIyarn dev会同时起前端编译和服务端监听保存文件刷新浏览器即可。只写了前端组件可以加--client只写了接口就用yarn dev-server起需要的就行省时间。切换数据库方言的最小改动配置入口是 examples/app/single-app.ts 里的database对象每个字段都从环境变量读取改连接参数不用碰代码环境变量含义示例值DB_DIALECT数据库方言postgres/mysql/sqlite/mariadbDB_HOST/DB_PORT主机与端口127.0.0.1/5432DB_USER/DB_PASSWORD用户名与密码按你的实例填DB_DATABASE库名nocobaseDB_STORAGESQLite 文件路径storage/db/nocodb.dbDB_LOGGING是否打印 SQLon给示例接上远程实例这样启动DB_DIALECTpostgres DB_HOST127.0.0.1 DB_PORT5432 \ DB_USERpostgres DB_PASSWORDsecret DB_DATABASEnocodb \ yarn run:example app/single-app start 提示dialect必须写小写官方名大小写或拼写错误会直接起不来想跑完整应用而不是示例改 docker/docker-compose.yml 里的连接信息即可。打开调试开关断点、日志与 inspect 端口最常用两个开关Node 的 inspect 端口挂断点DB_LOGGINGon打印全部 SQL。NODE_OPTIONS--inspect9229 yarn run:example app/single-app start # 浏览器打开 chrome://inspect挂上该进程即可打断点如果你用新版 CLInb它直接提供了nb source dev --inspect 9229少一步。排查数据问题再叠加DB_LOGGINGon终端就能看到每个请求实际执行的 SQL这就是 90% 场景够用的调试日志开关。你大概率会踩的 3 个坑坑都不致命但都会卡住人。下面三个出现频率最高坑一装依赖或构建时满屏报错症状yarn install或yarn dev直接报错esbuild 相关的平台错误最典型原因项目锁定 Node 20.16volta字段Node 22 或 18 都可能水土不服解法nvm use 20后重装依赖坑二yarn dev第一次启动页面白屏像卡死症状启动后浏览器长时间白屏原因首次要把 monorepo 里所有前端产物编译一遍等几分钟是正常的解法等终端编译完成若报错换yarn dev:umi切换到 umi 构建链的备选方案坑三改了插件配置页面还是老行为症状新增本地包或改了插件依赖后页面表现没变化原因新增包要重新关联部分配置变更需要 dev server 重启才生效解法CtrlC 后重跑yarn dev新增过包就先执行yarn install 提示三个坑的自查顺序一致——先查 Node 版本再想是不是首次编译没等完最后再重启基本能覆盖九成问题。 接下来去哪看环境跑通之后想深入时认准这几个位置就够了examples/single-app、multi-app、迁移脚本等最小示例想手写资源、action 或数据库迁移时先看这里docs/docs/cn/plugin-development/write-your-first-plugin.md写第一个插件前先看这个docs/docs/cn/development/开发指南总览覆盖插件、FlowEngine、RunJS计划扩展某类功能时看packages/core/server、database、acl 等核心模块源码想搞懂底层或提 PR 时看docker/docker-compose.yml一键完整实例想验收真实应用形态时用【免费下载链接】nocobaseNocoBase is an open-source AI no-code platform for building business systems fast. Instead of generating everything from scratch, AI works on top of production-proven infrastructure and a WYSIWYG no-code interface, so you get both speed and reliability.项目地址: https://gitcode.com/GitHub_Trending/no/nocobase创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考