nocobase/README.zh-CN.md

114 lines
3.2 KiB
Markdown
Raw Normal View History

2021-03-29 05:07:09 +00:00
[English](./README.md) | 简体中文
2021-03-29 05:32:26 +00:00
2021-09-28 04:58:02 +00:00
![](https://www.nocobase.com/images/demo/11.png)
2021-03-29 05:32:26 +00:00
NocoBase 是什么
----------
2021-10-20 03:36:26 +00:00
NocoBase 是一个极易扩展的开源无代码开发平台。
无需编程,使用 NocoBase 搭建自己的协作平台、管理系统,只需要几分钟时间。
2021-03-29 05:32:26 +00:00
2021-09-28 12:08:07 +00:00
[https://www.nocobase.com/cn](https://www.nocobase.com/cn)
2021-03-29 05:32:26 +00:00
哪些场景适合使用 NocoBase
----------
- 中小企业和组织为自己或者为所在行业搭建业务平台和管理系统
- 希望价格足够低,甚至免费
- 不懂编程也可以灵活定制
- 需要完全掌控源代码和数据
- 可以以自有产品的形态自由分发和销售
- 服务商和外包团队为客户开发协作平台和管理系统
- 希望尽可能降低开发成本
- 需要极致友好的二次开发体验
- 必须以独立产品的形态为客户私有部署
- 客户可以自由分发和销售
为什么选择 NocoBase
----------
- 开源免费
- 采用 MIT 许可协议,不限制商业使用
- 拥有全部代码,私有化部署,保障数据私有和安全
- 针对实际需求自由扩展开发
- 具备良好的生态支持
- 无代码能力强
2021-09-28 04:58:02 +00:00
- 所见即所得的可视化配置
- 数据结构配置与界面配置分离
- 丰富的区块和操作任意组合
- 基于角色的访问权限
2021-03-29 05:32:26 +00:00
- 对开发者友好
- 微内核,灵活易扩展,具备健全的插件体系
2021-09-28 04:58:02 +00:00
- 基于 Node.js使用主流框架和技术包括 Koa、Sequelize、React、Formily、Ant Design 等
2021-03-29 05:32:26 +00:00
- 渐进式开发,上手难度低,对新人友好
- 不绑架、不强依赖,可任意组合使用或扩展,可用于现有项目中
2021-10-20 03:36:26 +00:00
说明
----------
NocoBase 仍处于早期开发阶段,功能不完整,稳定性不高,仅用于预览,不适合在生产环境中使用。相对稳定以及包含完善文档的公开测试版预计最早将于 2022 年第一季度发布。
2021-10-21 02:13:57 +00:00
如果你希望加入我们一起开发 NocoBase或者探讨 NocoBase 未来发展,或者需要提供 NocoBase 使用上的帮助欢迎通过邮件联系我们hello@nocobase.com
2021-10-21 02:26:57 +00:00
或者添加我们的微信:
2021-10-21 02:13:57 +00:00
![](https://www.nocobase.com/images/wechat.png)
2021-10-20 03:36:26 +00:00
2021-03-29 05:32:26 +00:00
NocoBase 架构
----------
2021-09-28 04:58:02 +00:00
![](https://docs.nocobase.com/static/NocoBase.c9542b1f.png)
2021-03-29 05:32:26 +00:00
2021-03-30 12:27:01 +00:00
环境要求
2021-03-29 05:32:26 +00:00
----------
2021-03-30 12:27:01 +00:00
Node:
2021-03-29 05:32:26 +00:00
2021-10-07 10:01:45 +00:00
- Node.js 12.20+
2021-03-29 05:32:26 +00:00
2021-03-30 12:27:01 +00:00
Database:
2021-03-29 05:32:26 +00:00
2021-03-30 12:27:01 +00:00
- PostgreSQL 10.x+
- Sqlite 3+
2021-03-30 12:27:01 +00:00
安装 & 运行
----------
2021-03-29 05:32:26 +00:00
2021-10-07 16:32:40 +00:00
### 通过 `create-nocobase-app` 创建项目
2021-04-07 12:34:30 +00:00
2021-10-25 06:47:28 +00:00
#### 快速启动
2021-04-07 12:34:30 +00:00
~~~shell
yarn create nocobase-app my-nocobase-app --quickstart --lang=zh-CN
# `--lang=en-US` 语言设置,支持 `--lang=en-US` 和 `--lang=zh-CN`
~~~
2021-10-25 06:47:28 +00:00
#### 分步骤执行
~~~shell
# 1. 创建项目
yarn create nocobase-app my-nocobase-app
# 2. 切换到项目根目录
cd my-nocobase-app
# 3. 初始化数据
yarn nocobase init --import-demo --lang=zh-CN
# `--import-demo` 导入演示数据
# `--lang=en-US` 语言设置,支持 `--lang=en-US` 和 `--lang=zh-CN`
# 4. 启动项目
2021-10-07 10:01:45 +00:00
yarn start
2021-04-07 12:34:30 +00:00
~~~
使用浏览器打开 http://localhost:8000
2021-10-07 16:32:40 +00:00
2021-11-01 01:33:04 +00:00
### 使用 docker
2021-10-07 16:32:40 +00:00
2021-11-01 01:33:04 +00:00
```bash
# 启动 app
2021-11-01 10:16:04 +00:00
docker run --name my-nocobase-app -p 8000:13002 -d nocobase/nocobase
2021-11-01 01:33:04 +00:00
# 查看日志
docker logs my-nocobase-app
2021-10-07 16:32:40 +00:00
```
2021-11-01 10:16:04 +00:00
使用浏览器打开 http://localhost:8000
2021-10-07 16:32:40 +00:00
2021-11-01 01:33:04 +00:00
## 参与贡献
2021-04-07 12:34:30 +00:00
2021-11-01 01:33:04 +00:00
https://docs.nocobase.com/zh-CN/guide/contributing