# Notadd

**Repository Path**: ScrumLeanMaster/notadd

## Basic Information

- **Project Name**: Notadd
- **Description**: 基于 Nest.js(Node.js) + React 或 Laravel (PHP) + vue 的模块化敏捷开发系统架构，具有高性能、前后端分离等特点。
- **Primary Language**: NodeJS
- **License**: Apache-2.0
- **Default Branch**: next
- **Homepage**: https://www.notadd.com/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 76
- **Created**: 2018-04-18
- **Last Updated**: 2024-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center"><img src="https://www.notadd.com/src/notado_logo420x96.svg" alt="Notadd Logo."></p>
<p align="center">
<a href="https://jq.qq.com/?_wv=1027&k=5qVzRh4" title="Notadd 官方技术交流群"><img src="https://img.shields.io/badge/QQ%20Group-321735506-6782d6.svg?style=flat-square"></a>
<a href="https://gitq.com/notadd/notadd" title="Build Status"><img src="https://gitq.com/badge.svg"></a>
<a href="https://travis-ci.org/notadd/next" title="Build Status"><img src="https://img.shields.io/travis/notadd/next.svg?style=flat-square"></a>
</p>


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

[View PHP  Version](https://github.com/notadd/notadd/tree/php-master)


> "Development fast" like building blocks as fast as you meet your development needs
>
> "High-performance" single machine concurrent easy tens of thousands
>
> "easy to maintain" class spring general excellent architecture, easy maintenance and two times development



## Related Technology

- [TypeScript](http://www.typescriptlang.org/)
- Node.js & Nest.js
- React.js & [Material-UI](https://material-ui-next.com/)
- GraphQL API
- Redis

## Features

- [x] Complete separation of front and back, no refresh on page, significantly lower back-end load
- [x] Asynchronous High-performance applications, single machine concurrency easy tens of thousands
- [ ] Support SSR rendering, better SEO
- [x] supports react dynamic form generation
- [x] GRAPHQL interface, multiple request merging
- [x] more than 6 databases based on Typeorm native support
- [x] native support Websocket real-time communication
- [x] native support GRPC, cross-process, cross-language, cross-server communication
- [ ] to support the PWA technology, the realization of disconnected network reminders, broken network form save, Web page offline message push.

## Modular Design

![notadd](https://www.notadd.com/src/app.svg)

Enterprise Official Website: CMS module + neditor plugin, message board plugin.

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

Micro-letter Mall: User module, mall module, micro-letter module + micro-letter large turntable, payment plug-in, offline verification plug-in.

Catering Program: User module, mall module, micro-letter module + Point meal Plug-in, sweep code payment plug-ins, passenger flow monitoring plug-ins ... + infrared sensor expansion, WiFi probe expansion.

Hotel Program: User module, hotel module, micro-letter module + booking plug-in, payment plug-in, intelligent WiFi plugin + WiFi probe expansion, door card system expansion.

CRM system: User module, CRM module ...

More can be imagined ...

## CDN Scheme

![cdn](https://www.notadd.com/src/cdn.svg)

## Documentation

[https://docs.notadd.com/](https://docs.notadd.com/)

## App Store（AD hoc）

[https://notadd.store/](https://notadd.store/)


## System Environment

- System：`Linux（👍）`/ `macOS` / `Windows 2008+`
- Node.js ：`≥` **8.0**
- Database：`PostgreSQL 9.4+（👍）`/ `MySQL 5.7+` / `Oracle 12+` / `MS SQL Server 2012+` / `MariaDB 10.2.28+` / `SQLite 3.9+` 
- Redis：`Redis 3.2+`

## Quick Start

Downloading the Notadd `Node.js` version:

```shell
git clone --branch https://github.com/notadd/notadd
cd notadd
```

### Install 

> Copy `ormconfig.yml.example` named `ormconfig.yml` and modify its database configuration.

Installing Dependency Packages and Installing Databases：

```shell
yarn install
yarn run:install
```

### Run

```shell
yarn serve
```

## Monthly Report

- [September 2017](https://blog.notadd.com/2017/09/22/2017-09/)
- [August 2017](https://blog.notadd.com/2017/09/01/2017-08/)
- [July 2017](https://blog.notadd.com/2017/08/01/2017-07/)

## Sponsors

We would like to extend our thanks to the following sponsors for helping fund on-going Notadd development. If you are interested in becoming a sponsor, please visit the Notadd [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 


## Communication

QQ Group：[321735506](https://jq.qq.com/?_wv=1027&k=5qVzRh4)

Forum ：https://bbs.notadd.com

Blog ：https://blog.notadd.com

## Excellent Repositories

- [Swoft](https://github.com/swoft-cloud/swoft) Modern High performance AOP and Coroutine PHP Framework, base on Swoole 2
- [ThinkSNS Plus](https://github.com/slimkit/thinksns-plus) Use of Laravel framework to achieve the user ecosystem.
- [Neditor](https://github.com/notadd/neditor) A modern editor based on the Ueditor.

## Credits


### Contributors

Thank you to all the people who have already contributed to notadd!
<a href="graphs/contributors"><img src="https://opencollective.com/notadd/contributors.svg?width=890&button=false" /></a>

Pull requests is welcome. For major changes, please put forward the Issue first and join us in discussing what you want to change.

> Thank you for thinking about contributing to Notadd! Specific contribution guides can be viewed at [Notadd document-contributions](https://docs.notadd.com/introductions/#贡献).
>
> [Apply to join Notadd Development Group](https://github.com/notadd/notadd/issues/195)

### Backers

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

<a href="https://opencollective.com/notadd#backers" target="_blank"><img src="https://opencollective.com/notadd/backers.svg?width=890"></a>


### Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/notadd#sponsor))

<a href="https://opencollective.com/notadd/sponsor/0/website" target="_blank"><img src="https://opencollective.com/notadd/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/notadd/sponsor/1/website" target="_blank"><img src="https://opencollective.com/notadd/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/notadd/sponsor/2/website" target="_blank"><img src="https://opencollective.com/notadd/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/notadd/sponsor/3/website" target="_blank"><img src="https://opencollective.com/notadd/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/notadd/sponsor/4/website" target="_blank"><img src="https://opencollective.com/notadd/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/notadd/sponsor/5/website" target="_blank"><img src="https://opencollective.com/notadd/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/notadd/sponsor/6/website" target="_blank"><img src="https://opencollective.com/notadd/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/notadd/sponsor/7/website" target="_blank"><img src="https://opencollective.com/notadd/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/notadd/sponsor/8/website" target="_blank"><img src="https://opencollective.com/notadd/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/notadd/sponsor/9/website" target="_blank"><img src="https://opencollective.com/notadd/sponsor/9/avatar.svg"></a>

## License

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

----------

[![upyun](https://www.notadd.com/src/upyun.svg "又拍云")](https://console.upyun.com/register/?invite=r17EYO3BW) Provide sponsorship