2021-03-29 13:07:09 +08:00
English | [简体中文 ](./README.zh-CN.md )
2021-09-28 13:02:14 +08:00
![](https://www.nocobase.com/images/demo/11.png)
2021-03-29 10:14:11 +08:00
Note
----------
2021-09-28 13:12:08 +08:00
NocoBase is still in early development and is for preview purposes only and is not suitable for use in a production environment. A relatively stable and well-documented public beta is expected to be released as early as the first quarter of 2022.
2021-03-29 10:14:11 +08:00
If you are interested in NocoBase, please join us to discuss and develop it together.
2021-03-29 10:15:51 +08:00
https://www.nocobase.com/
2021-03-29 10:14:11 +08:00
hello@nocobase.com
2021-02-24 21:18:33 +08:00
What is NocoBase
----------
NocoBase is an open source and free no-code development platform. Whether you are a business executive who does not know programming or a developer who is proficient in programming, you can quickly build various customized and privately deployed collaboration platforms and management systems.
When to use Nocobase
----------
2021-02-24 21:25:13 +08:00
- **SMEs and organizations build business platforms and management systems for themselves or for their industry**
2021-02-24 21:18:33 +08:00
- Want the price to be low enough or even free
- Can be flexibly customized without programming knowledge
- Need full control of source code and data
- Can freely distribute and sell as their own products
2021-02-24 21:25:13 +08:00
- **Service providers and outsourcing teams develop collaboration platforms and management systems for their clients**
2021-02-24 21:18:33 +08:00
- Want to keep development costs as low as possible
- Need the most user-friendly secondary development experience
- Must be deployed privately as a standalone product for the client
- Can be freely distributed and sold by the client
Why choose NocoBase
----------
2021-02-24 21:25:13 +08:00
- **Open source and free**
2021-02-24 21:18:33 +08:00
- Unrestricted commercial use under the MIT license
- Full code ownership, private deployment, private and secure data
- Free to expand and develop for actual needs
- Good ecological support
2021-02-24 21:25:13 +08:00
- **Strong no-code capability**
2021-09-28 13:02:14 +08:00
- WYSIWYG visual configuration
- Separation of data structure configuration from interface configuration
- Rich combination of blocks and operations
- Role-based access control
2021-02-24 21:25:13 +08:00
- **Developer-friendly**
2021-02-24 21:18:33 +08:00
- Microkernel architecture, flexible and easy to extend, with a robust plug-in system
2021-09-28 13:02:14 +08:00
- Node.js-based, with popular frameworks and technologies, including Koa, Sequelize, React, Formily, Ant Design, etc.
2021-04-04 23:33:06 +08:00
- Progressive development, easy for getting-started, friendly to newcomers
- No binding, no strong dependencies, can be used in any combination or extensions, can be used in existing projects
2020-11-11 15:23:39 +08:00
2021-03-29 13:21:35 +08:00
Architecture
----------
2021-09-28 13:02:14 +08:00
![](https://docs.nocobase.com/static/NocoBase.c9542b1f.png)
2021-03-29 13:21:35 +08:00
2021-03-30 20:27:01 +08:00
Requirements
2020-11-11 15:23:39 +08:00
----------
2021-03-30 20:27:01 +08:00
Node:
2020-11-11 15:23:39 +08:00
2021-10-07 18:01:45 +08:00
- Node.js 12.20+
2020-11-11 15:23:39 +08:00
2021-10-07 18:01:45 +08:00
Database:
2020-11-11 15:23:39 +08:00
2021-10-07 18:01:45 +08:00
- PostgreSQL 10.x+
2021-03-30 20:27:01 +08:00
Installation
----------
2020-11-11 15:23:39 +08:00
2021-10-07 18:01:45 +08:00
Create a project with `create-nocobase-app`
2021-04-07 20:34:30 +08:00
2020-11-11 15:23:39 +08:00
~~~shell
2021-10-07 18:01:45 +08:00
mkdir my-nocobase-app & & cd my-nocobase-app
yarn create nocobase-app
2020-11-11 15:23:39 +08:00
cp .env.example .env
2021-10-07 18:01:45 +08:00
docker-compose up -d postgres
yarn install
yarn start
2020-11-11 15:23:39 +08:00
~~~
2021-10-07 18:01:45 +08:00
Participate in the development
2021-04-17 22:47:08 +08:00
2021-10-07 18:01:45 +08:00
~~~shell
2021-04-17 22:47:08 +08:00
git clone https://github.com/nocobase/nocobase.git
cd nocobase
2021-10-07 18:01:45 +08:00
docker-compose up -d postgres # 用 docker 启动数据库
cp .env.example .env # 配置数据库信息、APP 端口等
yarn install
yarn run bootstrap
yarn run build
yarn start
2020-11-11 15:23:39 +08:00
~~~