Skip to content

Repository files navigation

nest-cloud

简介

nest-cloud 是一个基于 apps/* 工作区组织的多应用后端仓库。

当前仓库实际包含以下子项目:

  • apps/common-service:统一基础设施内核

架构分层

common-service

common-service 负责沉淀其他服务共用的基础设施能力,当前已确认包括:

  • 配置中心接入
  • 注册中心客户端
  • 统一日志
  • TypeORM 数据库接入

常用根命令

pnpm install
pnpm build
pnpm start:config
pnpm start:system
pnpm start:stock
pnpm lint
pnpm tsgo

其中 pnpm tsgo 会先构建 apps/common-service,再通过 tsgo 执行根级类型检查。

当前仓库已经声明 pnpm-workspace.yaml 与根级 packageManager,正式文档和后续命令约定统一以 pnpm 为准。

文档导航

项目级文档

服务级文档

文档维护规则

  • /docs/project 只存放项目级架构设计文档。
  • /docs/experience 只存放任务执行中的失败经验。
  • 同一类内容必须按职责或功能拆分,索引页只做导航,不承载整类正文。
  • apps/common-service 的文档按共享能力拆分到自身 docs/
  • 其他 apps/* 子项目都必须在各自根目录维护 docs/<模块>/

开发约束摘要

  • 配置统一通过 getConfigConfigKey 获取。
  • 日志统一使用 logger,不使用 console
  • 可复用静态值应提取为常量。
  • 无状态通用逻辑优先收敛到 utils
  • 架构、共享能力、服务模块或失败经验发生变化时,必须同步更新对应文档。

About

测试github api

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages