Sora

快速搭建 MVP 的渐进式 TypeScript 微服务框架

开箱即用的脚手架工具将工程配置自动化，几分钟内从想法到可运行的服务。业务成长后平滑演进到分布式集群，代码无需重写

📄 文档 · 🚀 快速开始 · 🐛 提交 Issue

---

特性

• 快速搭建 MVP — 开箱即用的脚手架工具将工程配置、代码生成自动化，sora new 即刻专注业务逻辑验证想法
• 渐进式基础设施 — 服务发现、传输协议、编解码器均可按需替换，从单进程到分布式集群切换只需一行代码
• RPC 通信 — 支持 TCP、HTTP、WebSocket 多种传输协议，提供请求/响应、单向通知、广播三种通信模式
• 服务发现 — 内置服务注册与发现机制，支持内存发现和 etcd 分布式发现，自动感知服务上下线
• 组件系统 — 可插拔的组件架构，内置 Redis、Database、etcd 组件，引用计数自动管理生命周期
• 类型安全 — 基于 typia AOT 编译时校验
• 分布式追踪 — W3C Trace Context 兼容，RPC 调用自动传播追踪上下文
• CLI 工具 — 脚手架生成项目、Service、Worker、Command 等代码模板

快速开始

# 安装 CLI
npm install -g @sora-soft/sora-cli

# 从模板创建项目
sora new my-project

详见 快速开始。

包结构

包	说明
@sora-soft/framework	核心框架：RPC、生命周期、组件、追踪等
@sora-soft/sora-cli	CLI 脚手架工具
@sora-soft/typia-decorator	@guard 参数校验装饰器
@sora-soft/redis-component	Redis 组件
@sora-soft/database-component	Database 组件
@sora-soft/etcd-component	etcd 组件
@sora-soft/etcd-discovery	etcd 服务发现
@sora-soft/ram-discovery	内存服务发现
@sora-soft/http-support	HTTP 传输支持

文档

完整文档请访问 sora-soft.github.io/sora-monorepo

• 指南
• 微服务架构
• RPC 通信
• 工具
• API 参考

开发

# 克隆仓库
git clone https://github.com/sora-soft/sora-node.git
cd sora-monorepo

# 安装依赖
pnpm install

# 构建所有包
pnpm -r run build

许可证

WTFPL