README

概述

中文文档

Notadd 是一个基于 Nest.js 框架的开源微服务开发架构，允许您使用适合不同业务需求的正确模块和插件来构建微服务系统。Notadd 正式提供抽象公共服务层。在服务层内部，每个模块都为 Notadd 主程序提供 Grpc 接口。例如，一个 CMS 系统，您可以使用官方提供的 nt-module-cms 和 nt-module-user 模块作为底层服务层。然后使用 Notadd 主程序根据服务层定义的 protobuf 消息协议编写您的 API 层代码。

特点

• [微服务] 支持独立部署和微服务
• [高性能] 异步高性能应用，支持数万级并发
• [易于维护] 使用 TypeScript 开发，具有智能代码提示和编译时代码检查机制
• [可插拔] 模块化开发系统，根据业务需求选择合适的模块，构建 API 层

技术栈

• Typescript
• Nest.js
• GraphQL
• TypeORM
• Grpc
• Redis

系统架构

模块化设计

企业官方网站：CMS 模块 + neditor 插件，论坛插件

信息发布：CMS 模块，用户模块 + CMS 多用户插件，Neditor 插件

微信商城：用户模块，商城模块，微信模块 + 微信大转盘，支付插件，离线验证插件

餐饮方案：用户模块，商城模块，微信模块 + 订单插件，扫码支付插件，客流监控插件 ... + 红外传感器开发，WiFi 探针扩展

酒店程序：用户模块，酒店模块，微信模块 + 预订插件，支付插件，智能 WiFi 插件 + WiFi 探针扩展，门禁系统扩展

CRM 系统：用户模块，CRM 模块 ...

更多想象空间 ...

快速开始

1. 将 Rpc 样例服务克隆到本地 nt-rpc-demo
2. 将用户服务克隆到本地 nt-module-user
3. 根据 nt-rpc-demo 和 nt-module-user 的说明启动微服务
4. 将此项目克隆到本地
5. 安装依赖于 yarn install
6. 启动 yarn start
7. 打开浏览器并访问 localhost:5000/graphql
8. 测试 GraphQL API

注意：Notadd 主程序在此阶段提供示例代码，不排除以后删除所有 graphql api 代码的可能性。

模块列表

• nt-module-user 用户模块
• nt-module-cms CMS 模块

插件列表

• nt-addon-pay 支付插件
• nt-addon-wechatapi 微信api插件

贡献

欢迎提交拉取请求。对于重大更改，请提交 Issue 并与我们讨论您想要更改的内容。

贡献者

感谢所有为notadd做出贡献的人！

通讯

腾讯QQ群：322247106

论坛：建设中

博客：建设中

优秀仓库

• Swoft 基于 Swoole 2 的现代高性能 AOP 和协程 PHP 框架。
• Neditor 基于 Ueditor 的现代编辑器。

赞助商

感谢以下赞助商对我们 Notadd 的开发提供资金支持。如果您有兴趣成为赞助商，请访问 Notadd 的 Gitee 页面

• 中国西安 · 比初网络
• 中国杭州 · 又拍云
• 中国西安 · 玛达网络

（请您的公司通过 成为赞助商 来支持这个开源项目）

支持者

感谢所有我们的支持者！ 成为支持者

许可证

Notadd 是开源软件，许可协议为 Apache 2.0 许可协议。

待办事项

• 国际化（i18n）支持
• 公共服务如 cms、pay、config、storage、logger 等。
• 服务治理、融合、降级、负载、注册和发现
• 支持 PWA 技术，实现离屏提醒、Web-off 表单保存、网页离线消息推送