一、开源项目简介

灵矶

灵矶是一个灵活多变的应用系统，应用开发者可以基于灵矶做出丰富应用逻辑，而核心开发者可以聚焦于关键模块的稳定性和对不同环境的适配。

二、开源协议

使用Apache-2.0开源协议

三、界面展示

四、功能概述

灵矶采用三层结构设计，分别为内核层、模块层和插件层。

• 内核层：提供核心插件机制和统一接口；

• 模块层：实现特定应用功能，例如：使用灵矶构建低代码平台，或作为服务编排工具；

• 插件层：提供更多选择，例如在已有认证机制模块的基础上，插件层可实现不同的认证方式。

目前，灵矶的目标是处理框架本身的核心功能与一部分通用业务逻辑，同时提供一定的无代码与 AI 能力，提升使用的便捷性。灵矶的未来将发展为一个灵活的底座，与不同产品结合，形成独特的定位。

路线图

以下是大致的开发路线图，具体开发计划将在春节前公布，届时会与相关应用模板一起发布。

• 内核：内核 API

• 内核：消息机制

• 内核：模块 API

• 模块：基于 antd 风格的界面

• 模块：工作流

• 模块：无代码能力

• 模块：云函数

• 模块：云组件

• 模块：消息队列

• 模块：定时任务

• 插件：工作流 - 审批

• 插件：工作流 - 数据模板

UI 规划方面，核心的机制设计在内核层，具体组件则由模块层提供。

• 内核：弹窗交互（适用于不脱离上下文的交互情况）

• 内核：标签页交互（适用于同一主题下单一页面无法承载太多内容的交互情况）

• 内核：独立页面（适用于核心主题和分享的情况）

• 模块：基本组件（单行文本、多行文本、数字等）

• 模块：关联组件（子表格、子详情等）

• 模块：专用组件（看板、日历、甘特图、文件浏览器等）

五、技术选型

快速开始

pnpm install
pnpm tachybase install
pnpm dev

默认的账号为：tachybase，默认密码为 !Admin123. 默认初始化使用的是 sqlite 数据库，推荐使用生产用的关系型数据库

第三方代码声明

项目中包含大量来自第三方库的代码，例如 NocoBase、Formily 和 Ant Design（antd）。这些代码遵循其原有的版权和协议要求。未来会逐步进行重构和替换，在项目早期使用时请注意相关授权要求。