PHPackages                             notadd/notadd - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. notadd/notadd

ArchivedProject[Framework](/categories/framework)

notadd/notadd
=============

The Notadd Framework.

0.16.2(8y ago)2.8k23398[65 PRs](https://github.com/notadd/notadd/pulls)Apache-2.0TypeScriptPHP &gt;=7.0

Since Nov 21Pushed 1y ago116 watchersCompare

[ Source](https://github.com/notadd/notadd)[ Packagist](https://packagist.org/packages/notadd/notadd)[ Docs](https://notadd.com)[ RSS](/packages/notadd-notadd/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (10)Dependencies (7)Versions (44)Used By (0)

[![Notadd Logo.](https://camo.githubusercontent.com/2c5c778dc1e635b47d0954e1a4698cd428865b9954fc444104158e239334ab6a/68747470733a2f2f7777772e6e6f746164642e636f6d2f7372632f6e6f7461646f5f6c6f676f3432307839362e737667)](https://camo.githubusercontent.com/2c5c778dc1e635b47d0954e1a4698cd428865b9954fc444104158e239334ab6a/68747470733a2f2f7777772e6e6f746164642e636f6d2f7372632f6e6f7461646f5f6c6f676f3432307839362e737667)

Overview
========

[](#overview)

[中文文档](./README_zh.md)

Notadd is an open source, Nest.js framework-based microservice development architecture that allows you to build a microservices system using the right modules and addons for different business needs. Notadd officially provides an abstract public service layer. Within the service layer, each module provides the Grpc interface for the Notadd main program to call. For example, a CMS system, you can use the officially provided `nt-module-cms` and `nt-module-user` modules as the underlying service layer. Then use the Notadd main program to write your API layer code according to the `protobuf` message protocol defined by the service layer.

Features
========

[](#features)

- **\[Microservice\]** Supports stand-alone deployment and microservice
- **\[High Performance\]** Asynchronous high-performance applications, tens of thousands of concurrent
- **\[Easy to maintain\]** Developed with Typescript, intelligent code hints and compile-time code checking mechanisms
- **\[Pluggable\]** modular development system, according to business needs, select the appropriate module, build the API layer

Technology stack
----------------

[](#technology-stack)

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

System Architecture
===================

[](#system-architecture)

[![notadd-arch](https://camo.githubusercontent.com/3116cca26832794287dac9d52159c480f30275d030cc9a614c8182be2862b659/68747470733a2f2f7777772e6e6f746164642e636f6d2f7372632f6e6f746164642d617263682e737667)](https://camo.githubusercontent.com/3116cca26832794287dac9d52159c480f30275d030cc9a614c8182be2862b659/68747470733a2f2f7777772e6e6f746164642e636f6d2f7372632f6e6f746164642d617263682e737667)

Modular design
--------------

[](#modular-design)

Enterprise Official Website: CMS module + neditor plug-in, message board plugin

Information release: CMS module, user module + CMS multi-user plugin, Neditor plugin

WeChat Mall: User module, Mall module, WeChat module + WeChat big turntable, payment plug-in, offline verification plug-in

Dining plan: User module, Mall module, WeChat module + ordering plugin, scan code payment plug-in, passenger flow monitoring plug-in ... + infrared sensor development, WiFi probe expansion

Hotel Program: User module, Hotel module, WeChat module + booking plugin, payment plug-in, smart WiFi plugin + WiFi probe expansion, door card system expansion

CRM system: User module, CRM module ...

More to imagine ...

Quick Start
===========

[](#quick-start)

1. Clone Rpc sample service to the local [nt-rpc-demo](https://github.com/notadd/nt-rpc-demo)
2. Clone the user service to the local [nt-module-user](https://github.com/notadd/nt-module-user)
3. Start the microservice according to the instructions of `nt-rpc-demo` and `nt-module-user`
4. Clone this project to your local
5. Installation depends on `yarn install`
6. Start `yarn start`
7. Open a browser and go to `localhost:5000/graphql`
8. Test GraphQL API

> Note: The Notadd main program provides demo code at this stage, and does not rule out the removal of all graphql api code later.

Module list
-----------

[](#module-list)

- [nt-module-user](https://github.com/notadd/nt-module-user) user module
- [nt-module-cms](https://github.com/notadd/nt-module-cms) CMS module

Addon list
----------

[](#addon-list)

- [nt-addon-pay](https://github.com/notadd/nt-addon-pay) payment addon
- [nt-addon-wechatapi](https://github.com/notadd/nt-addon-wechatapi) wechatapi addon

Contribution
============

[](#contribution)

Welcome to Pull requests. For major changes, please file a Issue and discuss with us what you want to change.

Contributors
------------

[](#contributors)

Thanks to all those who have contributed to notadd! [![](https://camo.githubusercontent.com/53b926dcd429f90986f1e30260ed90485dd995c6c9a667e7579c51f2f545eb5e/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f6e6f746164642f636f6e7472696275746f72732e7376673f77696474683d38393026627574746f6e3d66616c7365)](https://github.com/notadd/notadd/graphs/contributors)

### Communication

[](#communication)

Tencent QQ Group：322247106

Forum: Under construction

Blog: Under construction

### Excellent Repositories

[](#excellent-repositories)

- [Swoft](https://github.com/swoft-cloud/swoft) Modern High performance AOP and Coroutine PHP Framework, base on Swoole 2
- [Neditor](https://github.com/notadd/neditor) A modern editor based on the Ueditor.

Sponsor
-------

[](#sponsor)

We would like to thank the following sponsors for funding the development of our Notadd. If you are interested in becoming a sponsor, please visit Notadd's [Gitee Page](https://gitee.com/notadd/notadd?donate=true):

- [China Xian · Benchu Network](https://www.ibenchu.com)
- [China Hanzhou · upyun](https://www.upyun.com)
- China Xian · Mada Network

(Please ask your company to support this open source project by [becoming a sponsor](https://opencollective.com/notadd#sponsor))

[![upyun](https://camo.githubusercontent.com/c512c31c4a0f01435641e73945eb49881cabf915b8b871afcdda80180cfb8bdc/68747470733a2f2f7777772e6e6f746164642e636f6d2f7372632f757079756e2e737667 "又拍云")](https://console.upyun.com/register/?invite=r17EYO3BW)

Backer
------

[](#backer)

Thank you to all our backers! [Become a backer](https://opencollective.com/notadd#backer)

[![](https://camo.githubusercontent.com/a3c00c8cd01bc6a395f7fb2416398ed71234ef218a1c0a9e04b20021a1fd7785/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f6e6f746164642f6261636b6572732e7376673f77696474683d383930)](https://opencollective.com/notadd#backers)

License
=======

[](#license)

The Notadd is open-sourced software licensed under the [Apache 2.0 license](LICENSE).

---

TODO
====

[](#todo)

- Internationalization (i18n) support
- Public services such as cms、pay、config、storage、logger, etc.
- Service governance, fuse, downgrade, load, registration and discovery
- Support PWA technology, implement off-screen reminders, web-off form saving, webpage offline message push

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance27

Infrequent updates — may be unmaintained

Popularity36

Limited adoption so far

Community33

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 75.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~10 days

Recently: every ~23 days

Total

44

Last Release

3019d ago

PHP version history (2 changes)0.1.0PHP &gt;=5.6.28

0.1.1PHP &gt;=7.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/5564821?v=4)[Seven Du](/maintainers/medz)[@medz](https://github.com/medz)

![](https://www.gravatar.com/avatar/a6bfab103f184a90de73712c2be5492a2379fce986002912549e5df33b93aae8?d=identicon)[377123](/maintainers/377123)

![](https://www.gravatar.com/avatar/bcd4c158b005050b2782968d4c82289029e4b77513723b52b8b629cba2dc0d90?d=identicon)[ibenchu](/maintainers/ibenchu)

![](https://www.gravatar.com/avatar/43dcfdc494d0c1d8518bbb7bcd79c6a8754df7c2fbf12cbf2411296c5b7b7a72?d=identicon)[zuohuadong](/maintainers/zuohuadong)

---

Top Contributors

[![renovate-bot](https://avatars.githubusercontent.com/u/25180681?v=4)](https://github.com/renovate-bot "renovate-bot (25 commits)")[![medz](https://avatars.githubusercontent.com/u/5564821?v=4)](https://github.com/medz "medz (4 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")[![huxuezhi](https://avatars.githubusercontent.com/u/40712140?v=4)](https://github.com/huxuezhi "huxuezhi (1 commits)")[![meepobrother](https://avatars.githubusercontent.com/u/8385261?v=4)](https://github.com/meepobrother "meepobrother (1 commits)")[![snyk-bot](https://avatars.githubusercontent.com/u/19733683?v=4)](https://github.com/snyk-bot "snyk-bot (1 commits)")

---

Tags

angularbbscmsexpressfastifymallmaterial2microservicemysqlnestnestjsnodejsnotaddpostgresqlshopspasqlite3typescriptframeworkcmsfoundationnotadd

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/notadd-notadd/health.svg)

```
[![Health](https://phpackages.com/badges/notadd-notadd/health.svg)](https://phpackages.com/packages/notadd-notadd)
```

###  Alternatives

[yii2-starter-kit/yii2-starter-kit

Yii2 Starter Kit Application Template

1.4k6.6k](/packages/yii2-starter-kit-yii2-starter-kit)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
