docs: update README.md

This commit is contained in:
chenos 2024-11-10 10:09:21 +08:00
parent bea2d4880e
commit 451210a248
120 changed files with 2137 additions and 1789 deletions

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

30
packages/core/build/README.md Executable file → Normal file
View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

30
packages/core/cache/README.md vendored Normal file
View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -15,13 +15,10 @@ export class ToManyInterface extends BaseInterface {
return null;
}
str = `${str}`.trim();
const items = str.split(',');
const { filterKey, targetCollection, transaction } = ctx;
console.log({ filterKey });
const targetInstances = await targetCollection.repository.find({
filter: {
[filterKey]: items,
@ -31,7 +28,7 @@ export class ToManyInterface extends BaseInterface {
// check if all items are found
items.forEach((item) => {
if (!targetInstances.find((targetInstance) => targetInstance[filterKey] == item)) {
if (!targetInstances.find((targetInstance) => targetInstance[filterKey] === item)) {
throw new Error(`"${item}" not found in ${targetCollection.model.name} ${filterKey}`);
}
});

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,11 +1,30 @@
# acl
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
基于角色的权限控制插件。
## 安装激活
## What is NocoBase
内置插件无需手动安装激活。
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## 使用方法
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,11 +0,0 @@
# acl
[English](./README.md) | 中文
基于角色的权限控制插件。
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1 +1,30 @@
# @nocobase/plugin-action-bulk-edit
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1 +1,30 @@
# @nocobase/plugin-action-bulk-update
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1 +1,30 @@
# @nocobase/plugin-action-duplicate
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +1,30 @@
# export
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# Export
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,222 +1,30 @@
# import
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
Excel 数据导入插件。
## 安装激活
## What is NocoBase
内置插件无需手动安装激活。
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## 导入说明
Homepage:
https://www.nocobase.com/
### 数字类型字段
Online Demo:
https://demo.nocobase.com/new
支持数字和百分比,`N/A``-` 的文案会被过滤掉
Documents:
https://docs.nocobase.com/
| 数字1 | 百分比 | 数字2 | 数字3 |
| -- | -- | -- | -- |
| 123 | 25% | N/A | - |
Commericial license & plugins:
https://www.nocobase.com/en/commercial
转 JSON 之后为
License agreement:
https://www.nocobase.com/en/agreement
```ts
{
"数字1": 123,
"百分比": 0.25,
"数字2": null,
"数字3": null,
}
```
### 布尔类型字段
输入文案支持(英文不区分大小写):
- `Yes` `Y` `True` `1` `是`
- `No` `N` `False` `0` `否`
| 字段1 | 字段2 | 字段3 | 字段4 | 字段4 |
| -- | -- | -- | -- | -- |
| 否 | 是 | Y | true | 0 |
转 JSON 之后为
```ts
{
"字段1": false,
"字段2": true,
"字段3": true,
"字段4": true,
"字段5": false,
}
```
### 日期类型字段
| DateOnly | Local(+08:00) | GMT |
| -- | -- | -- |
| 2023-01-18 22:22:22 | 2023-01-18 22:22:22 | 2023-01-18 22:22:22 |
转 JSON 之后为
```ts
{
"DateOnly": "2023-01-18T00:00:00.000Z",
"Local(+08:00)": "2023-01-18T14:22:22.000Z",
"GMT": "2023-01-18T22:22:22.000Z",
}
```
### 选择类型字段
选项值和选项标签都可作为导入文案,多个选项之间以以逗号(`,` ``)或顿号(`、`)区分
如字段 `优先级` 的可选项包括:
| 选项值 | 选项标签 |
| -- | -- |
| low | 低 |
| medium | 中 |
| high | 低 |
选项值和选项标签都可作为导入文案
| 优先级 |
| -- |
| 高 |
| low |
转 JSON 之后为
```ts
[
{ "优先级": "high" },
{ "优先级": "low" },
]
```
### 中国行政区字段
| 地区1 | 地区2 |
| -- | -- |
| 北京市/市辖区 | 天津市/市辖区 |
转 JSON 之后为
```ts
{
"地区1": ["11","1101"],
"地区2": ["12","1201"]
}
```
### 附件字段
| 附件 |
| --|
| https://www.nocobase.com/images/logo.png |
转 JSON 之后为
```ts
{
"附件": [
{
"filename": "logo.png",
"title": "logo.png",
"extname": ".png",
"url": "https://www.nocobase.com/images/logo.png"
}
]
}
```
### 关系类型字段
多条数据以逗号(`,` ``)或顿号(`、`)区分
| 部门/名称 | 分类/标题 |
| -- | -- |
| 开发组 | 分类1、分类2 |
转 JSON 之后为
```ts
{
"部门": [1], // 1 为部门名称为「开发组」的记录 ID
"分类": [1,2], // 1,2 为分类标题为「分类1」和「分类2」的记录 ID
}
```
### JSON 类型字段
| JSON1 |
| -- |
| {"key":"value"} |
转 JSON 之后为
```ts
{
"JSON": {"key":"value"}
}
```
### 地图几何图形类型
| Point | Line | Polygon | Circle |
| -- | -- | -- | -- |
| 1,2 | (1,2),(3,4) | (1,2),(3,4),(1,2) | 1,2,3 |
转 JSON 之后为
```ts
{
"Point": [1,2],
"Line": [[1,2], [3,4]],
"Polygon": [[1,2], [3,4], [1,2]],
"Circle": [1,2,3]
}
```
## 自定义导入格式
通过 `db.registerFieldValueParsers()` 方法注册自定义的 `ValueParser`,如:
```ts
import { BaseValueParser } from '@nocobase/database';
class PointValueParser extends BaseValueParser {
async setValue(value) {
if (Array.isArray(value)) {
this.value = value;
} else if (typeof value === 'string') {
this.value = value.split(',');
} else {
this.errors.push('Value invalid');
}
}
}
const db = new Database();
// type=point 的字段导入时,将通过 PointValueParser 解析数据
db.registerFieldValueParsers({
point: PointValueParser,
});
```
导入示例
| Point |
| --|
| 1,2 |
转 JSON 之后为
```ts
{
"Point": [1,2]
}
```
## Contact Us:
hello@nocobase.com

View File

@ -1,222 +0,0 @@
# import
[English](./README.md) | 中文
Excel 数据导入插件。
## 安装激活
内置插件无需手动安装激活。
## 导入说明
### 数字类型字段
支持数字和百分比,`N/A``-` 的文案会被过滤掉
| 数字1 | 百分比 | 数字2 | 数字3 |
| -- | -- | -- | -- |
| 123 | 25% | N/A | - |
转 JSON 之后为
```ts
{
"数字1": 123,
"百分比": 0.25,
"数字2": null,
"数字3": null,
}
```
### 布尔类型字段
输入文案支持(英文不区分大小写):
- `Yes` `Y` `True` `1` `是`
- `No` `N` `False` `0` `否`
| 字段1 | 字段2 | 字段3 | 字段4 | 字段4 |
| -- | -- | -- | -- | -- |
| 否 | 是 | Y | true | 0 |
转 JSON 之后为
```ts
{
"字段1": false,
"字段2": true,
"字段3": true,
"字段4": true,
"字段5": false,
}
```
### 日期类型字段
| DateOnly | Local(+08:00) | GMT |
| -- | -- | -- |
| 2023-01-18 22:22:22 | 2023-01-18 22:22:22 | 2023-01-18 22:22:22 |
转 JSON 之后为
```ts
{
"DateOnly": "2023-01-18T00:00:00.000Z",
"Local(+08:00)": "2023-01-18T14:22:22.000Z",
"GMT": "2023-01-18T22:22:22.000Z",
}
```
### 选择类型字段
选项值和选项标签都可作为导入文案,多个选项之间以以逗号(`,` ``)或顿号(`、`)区分
如字段 `优先级` 的可选项包括:
| 选项值 | 选项标签 |
| -- | -- |
| low | 低 |
| medium | 中 |
| high | 低 |
选项值和选项标签都可作为导入文案
| 优先级 |
| -- |
| 高 |
| low |
转 JSON 之后为
```ts
[
{ "优先级": "high" },
{ "优先级": "low" },
]
```
### 中国行政区字段
| 地区1 | 地区2 |
| -- | -- |
| 北京市/市辖区 | 天津市/市辖区 |
转 JSON 之后为
```ts
{
"地区1": ["11","1101"],
"地区2": ["12","1201"]
}
```
### 附件字段
| 附件 |
| --|
| https://www.nocobase.com/images/logo.png |
转 JSON 之后为
```ts
{
"附件": [
{
"filename": "logo.png",
"title": "logo.png",
"extname": ".png",
"url": "https://www.nocobase.com/images/logo.png"
}
]
}
```
### 关系类型字段
多条数据以逗号(`,` ``)或顿号(`、`)区分
| 部门/名称 | 分类/标题 |
| -- | -- |
| 开发组 | 分类1、分类2 |
转 JSON 之后为
```ts
{
"部门": [1], // 1 为部门名称为「开发组」的记录 ID
"分类": [1,2], // 1,2 为分类标题为「分类1」和「分类2」的记录 ID
}
```
### JSON 类型字段
| JSON1 |
| -- |
| {"key":"value"} |
转 JSON 之后为
```ts
{
"JSON": {"key":"value"}
}
```
### 地图几何图形类型
| Point | Line | Polygon | Circle |
| -- | -- | -- | -- |
| 1,2 | (1,2),(3,4) | (1,2),(3,4),(1,2) | 1,2,3 |
转 JSON 之后为
```ts
{
"Point": [1,2],
"Line": [[1,2], [3,4]],
"Polygon": [[1,2], [3,4], [1,2]],
"Circle": [1,2,3]
}
```
## 自定义导入格式
通过 `db.registerFieldValueParsers()` 方法注册自定义的 `ValueParser`,如:
```ts
import { BaseValueParser } from '@nocobase/database';
class PointValueParser extends BaseValueParser {
async setValue(value) {
if (Array.isArray(value)) {
this.value = value;
} else if (typeof value === 'string') {
this.value = value.split(',');
} else {
this.errors.push('Value invalid');
}
}
}
const db = new Database();
// type=point 的字段导入时,将通过 PointValueParser 解析数据
db.registerFieldValueParsers({
point: PointValueParser,
});
```
导入示例
| Point |
| --|
| 1,2 |
转 JSON 之后为
```ts
{
"Point": [1,2]
}
```

View File

@ -429,8 +429,6 @@ describe('xlsx importer', () => {
describe('import with associations', () => {
let User;
let Post;
let Tag;
beforeEach(async () => {
User = app.db.collection({
name: 'users',
@ -462,98 +460,12 @@ describe('xlsx importer', () => {
target: 'users',
interface: 'm2o',
},
{
type: 'belongsToMany',
name: 'tags',
target: 'tags',
interface: 'm2m',
through: 'postsTags',
},
],
});
Tag = app.db.collection({
name: 'tags',
fields: [
{
type: 'string',
name: 'name',
},
{
type: 'belongsToMany',
name: 'posts',
target: 'posts',
interface: 'm2m',
through: 'postsTags',
},
],
});
await app.db.sync();
});
it('should import many to many with id', async () => {
await Tag.repository.create({
values: [
{
title: 't1',
},
{
title: 't2',
},
],
});
const columns = [
{
dataIndex: ['title'],
defaultTitle: '名称',
},
{
dataIndex: ['tags', 'id'],
defaultTitle: 'IDS',
},
];
const templateCreator = new TemplateCreator({
collection: Post,
columns,
});
const template = await templateCreator.run();
const worksheet = template.Sheets[template.SheetNames[0]];
XLSX.utils.sheet_add_aoa(
worksheet,
[
['test', '1,2'],
['test2', 1],
],
{
origin: 'A2',
},
);
const importer = new XlsxImporter({
collectionManager: app.mainDataSource.collectionManager,
collection: Post,
columns,
workbook: template,
});
await importer.run();
const posts = await Post.repository.find({
appends: ['tags'],
});
expect(posts.length).toBe(2);
expect(posts[0]['tags'].map((item: any) => item.id)).toEqual([1, 2]);
expect(posts[1]['tags'].map((item: any) => item.id)).toEqual([1]);
});
it('should validate to many association', async () => {
const columns = [
{

View File

@ -1 +1,30 @@
# @nocobase/plugin-action-print
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,80 +1,30 @@
# api-doc
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## Introduction
## What is NocoBase
This plugin is based on `swagger` to write documentation.
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## How to access the documentation
Homepage:
https://www.nocobase.com/
1. The access address in the plugin center is `{domain}/admin/settings/api-doc/documentation`
2. The access address outside the plugin center is `{domain}/api-documentation`
Online Demo:
https://demo.nocobase.com/new
## How to write swagger documentation
Documents:
https://docs.nocobase.com/
> The method in the plugin is the same
Commericial license & plugins:
https://www.nocobase.com/en/commercial
1. `src/swagger.{ts,json}`
2. `src/swagger/index.{ts,json}`
License agreement:
https://www.nocobase.com/en/agreement
The file paths above can all be traversed to write documentation. Just export your written documentation by default. An example is shown below:
```ts
export default {
info: {
title: 'NocoBase API - Api-doc plugin',
},
tags: [],
paths: {},
components: {
schemas: {}
}
};
```
Usually, you only need to write **info.title**, **tags**, **paths**, and **components**. Other information such as **server** and **info** are merged into our **base-swagger**.
Base swagger includes the following code:
```ts
// base swagger
export default {
openapi: '3.0.3',
info: {
title: 'NocoBase API documentation',
description: '',
contact: {
url: 'https://github.com/nocobase/nocobase/issues',
},
license: {
name: 'Core packages are Apache 2.0 & Plugins packages are AGPL 3.0 licensed.',
url: 'https://github.com/nocobase/nocobase#license',
},
},
externalDocs: {
description: 'Find out more about NocoBase',
url: 'https://docs.nocobase.com/',
},
components: {
securitySchemes: {
'api-key': {
type: 'http',
scheme: 'bearer',
},
},
},
security: [
{
'api-key': [],
},
],
};
```
> Note that configurations that can only be obtained at runtime, such as the server and version fields, are not filled in the base-swagger.
You can also override these defaults. When writing the swagger documentation for your plugin, you should consider whether your plugin's documentation can be accessed independently.
For detailed swagger writing rules, please refer to the [official documentation](https://swagger.io/docs/specification/about/).
## Contact Us:
hello@nocobase.com

View File

@ -1,79 +0,0 @@
# api-doc
[English](./README.md) | 中文
## 简介
该插件基于 `swagger` 编写文档。
## 如何访问文档
1. 在插件中心访问地址是 `{domain}/admin/settings/api-doc/documentation`
2. 在插件中心外访问地址是 `{domain}/api-documentation`
## 如何编写 swagger 文档
> 插件内方式一样
1. `src/swagger.{ts,json}`
2. `src/swagger/index.{ts,json}`
上面的文件路径均可遍写文档,只需最后将您编写的文档默认导出即可,例子如下:
```ts
export default {
info: {
title: 'NocoBase API - Auth plugin',
},
tags: [],
paths: {},
components: {
schemas: {}
}
};
```
通常你只需要编写 **info.title**, **tags**, **paths**, **components** 即可其他内容如 **server**, **info** 的其他信息都合并我们的 **base-swagger**.
base swagger 包含如下代码
```ts
// base swagger
export default {
openapi: '3.0.3',
info: {
title: 'NocoBase API documentation',
description: '',
contact: {
url: 'https://github.com/nocobase/nocobase/issues',
},
license: {
name: 'Core packages are Apache 2.0 & Plugins packages are AGPL 3.0 licensed.',
url: 'https://github.com/nocobase/nocobase#license',
},
},
externalDocs: {
description: 'Find out more about NocoBase',
url: 'https://docs.nocobase.com/',
},
components: {
securitySchemes: {
'api-key': {
type: 'http',
scheme: 'bearer',
},
},
},
security: [
{
'api-key': [],
},
],
};
```
> 注意:涉及到运行时才能获取的配置,并没有填写在 base-swagger 里,如 server, version 字段
这些默认的配置你同样也可以覆盖它,在你编写插件的 `swagger` 文档时,你需要视你的插件文档是独立的文档,可以被单独访问。
详细的 `swagger` 编写规则请参考[官方文档](https://swagger.io/docs/specification/about/)

View File

@ -1,9 +1,30 @@
# api-keys
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# api-keys
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,11 +1,30 @@
# audit-logs
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
审计日志插件。
## 安装激活
## What is NocoBase
内置插件无需手动安装激活。
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## 使用方法
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,11 +0,0 @@
# audit-logs
[English](./README.md) | 中文
审计日志插件。
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,23 +1,30 @@
# SMS Auth
# NocoBase
提供短信登录认证功能。
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 依赖
- `@nocobase/auth` 认证插件,提供认证相关功能,表、模型、函数复用等。
- `@nocobase/plugin-verification` 验证码插件,提供短信发送功能。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
### 新增验证码Provider
插件设置 - Verification/验证码
新增一个Provider, 并设置为默认方式。
Homepage:
https://www.nocobase.com/
<img src="https://s2.loli.net/2023/05/16/6VKDcqW41F8P9Gu.png" width="800px" />
Online Demo:
https://demo.nocobase.com/new
### 新增SMS认证器
插件设置 - Authentication/认证
新增选择认证类型为SMS新增一个Authenticator。
Documents:
https://docs.nocobase.com/
效果如图:
<img src="https://s2.loli.net/2023/05/16/GVW5mHTvBhn8Zck.png" width="400px" />
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,117 +1,30 @@
# Auth
# NocoBase
提供基础认证功能和扩展认证器管理功能。
## 使用方法
### 认证器管理
页面:系统设置 - 认证
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
<img src="https://s2.loli.net/2023/05/15/NdriQZvBuE6hGRS.png" width="800px" />
## What is NocoBase
#### 内置认证器
- 名称basic
- 认证类型:邮箱密码登录
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
<img src="https://s2.loli.net/2023/05/15/HC4gtx9fQPrqvac.png" width="300px" />
Homepage:
https://www.nocobase.com/
<img src="https://s2.loli.net/2023/05/15/fcLqypdhOxnksbg.png" width="300px" />
Online Demo:
https://demo.nocobase.com/new
#### 增加认证器
Add new - 选择认证类型
Documents:
https://docs.nocobase.com/
<img src="https://s2.loli.net/2023/05/15/CR7UTDt2WzbEfgs.png" width="300px" />
Commericial license & plugins:
https://www.nocobase.com/en/commercial
#### 启用/禁用
Actions - Edit - 勾选/取消Enabled
License agreement:
https://www.nocobase.com/en/agreement
<img src="https://s2.loli.net/2023/05/15/2utpSHly9fzCKX5.png" width="400px" />
#### 配置认证器
Actions - Edit
## 开发一个登录插件
### 接口
Nocobase内核提供了扩展登录方式的接入和管理。扩展登录插件的核心逻辑处理需要继承内核的`Auth`类,并对相应的标准接口进行实现。
参考`core/auth/auth.ts`
```TypeScript
import { Auth } from '@nocobase/auth';
class CustomAuth extends Auth {
set user(user) {}
get user() {}
async check() {}
async signIn() {}
}
```
多数情况下扩展的用户登录方式也将沿用现有的jwt逻辑来生成用户访问API的凭证插件也可以继承`BaseAuth`类以便复用部分逻辑代码,如`check`, `signIn`接口。
```TypeScript
import { BaseAuth } from '@nocobase/auth';
class CustomAuth extends BaseAuth {
constructor(config: AuthConfig) {
const userCollection = config.ctx.db.getCollection('users');
super({ ...config, userCollection });
}
async validate() {}
}
```
### 用户数据
`@nocobase/plugin-auth`插件提供了`usersAuthenticators`表来建立users和authenticators即用户和认证方式的关联。
通常情况下,扩展登录方式用`users``usersAuthenticators`来存储相应的用户数据即可特殊情况下才需要自己新增Collection.
`users`存储的是最基础的用户数据,邮箱、昵称和密码。
`usersAuthenticators`存储扩展登录方式数据
- uuid: 该种认证方式的用户唯一标识如手机号、微信openid等
- meta: JSON字段其他需要保存的信息
- userId: 用户id
- authenticator认证器名字
对于用户操作,`Authenticator`模型也提供了几个封装的方法,可以在`CustomAuth`类中通过`this.authenticator[方法名]`使用:
- `findUser(uuid: string): UserModel` - 查询用户
- `newUser(uuid: string, values?: any): UserModel` - 创建新用户
- `findOrCreateUser(uuid: string, userValues?: any): UserModel` - 查找或创建新用户
### 注册
扩展的登录方式需要向内核注册。
```TypeScript
async load() {
this.app.authManager.registerTypes('custom-auth-type', {
auth: CustomAuth,
});
}
```
### 客户端API
#### OptionsComponentProvider
可供用户配置的认证器配置项
- authType 认证方式
- component 配置组件
```TypeScript
<OptionsComponentProvider authType="custom-auth-type" component={Options} />
```
`Options`组件使用的值是`authenticator``options`字段,如果有需要暴露在前端的配置,应该放在`options.public`字段中。`authenticators:publicList`接口会返回`options.public`字段的值。
#### SigninPageProvider
自定义登录页界面
- authType 认证方式
- tabTitle 登录页tab标题
- component 登录页组件
#### SignupPageProvider
自定义注册页界面
- authType 认证方式
- component 注册页组件
#### SigninPageExtensionProvider
自定义登录页下方的扩展内容
- authType 认证方式
- component 扩展组件
## Contact Us:
hello@nocobase.com

View File

@ -1,118 +1,30 @@
# Duplicator
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
NocoBase 应用的备份与还原插件,可用于应用的复制、迁移、升级等场景。
## 安装激活
## What is NocoBase
内置插件无需手动安装激活。
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## 使用方法
Homepage:
https://www.nocobase.com/
Duplicator 插件提供了 `dump``restore` 命令,分别用于备份和还原应用数据,可用于单应用的备份和还原,也可以跨应用。如果跨应用还原数据,请保证目标应用 NocoBase 版本与源应用一致,相对应插件也已下载本地。
Online Demo:
https://demo.nocobase.com/new
**⚠️ 如果使用了继承PostgreSQL、视图、触发器等不兼容的特性跨数据库还原备份数据可能失败。**
Documents:
https://docs.nocobase.com/
### 备份数据
Commericial license & plugins:
https://www.nocobase.com/en/commercial
```bash
yarn nocobase dump
```
License agreement:
https://www.nocobase.com/en/agreement
选择需要备份的插件表结构及其数据
```bash
? Select the plugin collections to be dumped (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
== Required ==
- migration (core) (Disabled)
- collections (collection-manager) (Disabled)
- uiSchemas (ui-schema-storage) (Disabled)
- uiRoutes (ui-routes-storage) (Disabled)
- acl (acl) (Disabled)
- workflowConfig (workflow) (Disabled)
- snapshot-field (snapshot-field) (Disabled)
- sequences (sequence-field) (Disabled)
== Optional ==
❯◉ executionLogs (workflow)
◉ users (users)
◉ storageSetting (file-manager)
◉ attachmentRecords (file-manager)
◉ systemSettings (system-settings)
◉ verificationProviders (verification)
◉ verificationData (verification)
◉ oidcProviders (oidc)
◉ samlProviders (saml)
◉ mapConfiguration (map)
(Move up and down to reveal more choices)
```
选择需要备份的其他数据表的记录
```bash
? Select the collection records to be dumped (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
❯◉ Test1
❯◉ Test2
❯◉ Test3
```
数据备份成功之后,备份文件位于 `storage/duplicator` 目录下:
```bash
dumped to /your/apps/a/storage/duplicator/dump-20230210T223910.nbdump
dumped file size: 20.8 kB
```
### 还原数据
```bash
yarn nocobase restore /your/apps/a/storage/duplicator/dump-20230210T223910.nbdump
```
导入前请先备份数据
```bash
? Danger !!! This action will overwrite your current data, please make sure you have a backup❗ (y/N)
```
选择需要还原的插件表结构及其数据
```bash
? Select the plugin collections to be restored (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
== Required ==
- migration (core) (Disabled)
- collections (collection-manager) (Disabled)
- uiSchemas (ui-schema-storage) (Disabled)
- uiRoutes (ui-routes-storage) (Disabled)
- acl (acl) (Disabled)
- workflowConfig (workflow) (Disabled)
- sequences (sequence-field) (Disabled)
== Optional ==
❯◯ executionLogs (workflow)
◯ users (users)
◯ storageSetting (file-manager)
◯ attachmentRecords (file-manager)
◯ systemSettings (system-settings)
◯ verificationProviders (verification)
◯ verificationData (verification)
◯ auditLogs (audit-logs)
◯ iframe html storage (iframe-block)
```
选择需要还原的其他数据表的记录
```bash
? Select the collection records to be restored (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
❯◉ Test1
❯◉ Test2
❯◉ Test3
```
成功之后,重启应用
```bash
# for development
yarn dev
# for production
yarn start
```
## Contact Us:
hello@nocobase.com

View File

@ -1,118 +0,0 @@
# Duplicator
[English](./README.md) | 中文
NocoBase 应用的备份与还原插件,可用于应用的复制、迁移、升级等场景。
## 安装激活
内置插件无需手动安装激活。
## 使用方法
Duplicator 插件提供了 `dump``restore` 命令,分别用于备份和还原应用数据,可用于单应用的备份和还原,也可以跨应用。如果跨应用还原数据,请保证目标应用 NocoBase 版本与源应用一致,相对应插件也已下载本地。
**⚠️ 如果使用了继承PostgreSQL、视图、触发器等不兼容的特性跨数据库还原备份数据可能失败。**
### 备份数据
```bash
yarn nocobase dump
```
选择需要备份的插件表结构及其数据
```bash
? Select the plugin collections to be dumped (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
== Required ==
- migration (core) (Disabled)
- collections (collection-manager) (Disabled)
- uiSchemas (ui-schema-storage) (Disabled)
- uiRoutes (ui-routes-storage) (Disabled)
- acl (acl) (Disabled)
- workflowConfig (workflow) (Disabled)
- snapshot-field (snapshot-field) (Disabled)
- sequences (sequence-field) (Disabled)
== Optional ==
❯◉ executionLogs (workflow)
◉ users (users)
◉ storageSetting (file-manager)
◉ attachmentRecords (file-manager)
◉ systemSettings (system-settings)
◉ verificationProviders (verification)
◉ verificationData (verification)
◉ oidcProviders (oidc)
◉ samlProviders (saml)
◉ mapConfiguration (map)
(Move up and down to reveal more choices)
```
选择需要备份的其他数据表的记录
```bash
? Select the collection records to be dumped (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
❯◉ Test1
❯◉ Test2
❯◉ Test3
```
数据备份成功之后,备份文件位于 `storage/duplicator` 目录下:
```bash
dumped to /your/apps/a/storage/duplicator/dump-20230210T223910.nbdump
dumped file size: 20.8 kB
```
### 还原数据
```bash
yarn nocobase restore /your/apps/a/storage/duplicator/dump-20230210T223910.nbdump
```
导入前请先备份数据
```bash
? Danger !!! This action will overwrite your current data, please make sure you have a backup❗ (y/N)
```
选择需要还原的插件表结构及其数据
```bash
? Select the plugin collections to be restored (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
== Required ==
- migration (core) (Disabled)
- collections (collection-manager) (Disabled)
- uiSchemas (ui-schema-storage) (Disabled)
- uiRoutes (ui-routes-storage) (Disabled)
- acl (acl) (Disabled)
- workflowConfig (workflow) (Disabled)
- sequences (sequence-field) (Disabled)
== Optional ==
❯◯ executionLogs (workflow)
◯ users (users)
◯ storageSetting (file-manager)
◯ attachmentRecords (file-manager)
◯ systemSettings (system-settings)
◯ verificationProviders (verification)
◯ verificationData (verification)
◯ auditLogs (audit-logs)
◯ iframe html storage (iframe-block)
```
选择需要还原的其他数据表的记录
```bash
? Select the collection records to be restored (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
❯◉ Test1
❯◉ Test2
❯◉ Test3
```
成功之后,重启应用
```bash
# for development
yarn dev
# for production
yarn start
```

View File

@ -1,11 +1,30 @@
# iframe-block
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
Iframe 区块插件。
## 安装激活
## What is NocoBase
内置插件无需手动安装激活。
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## 使用方法
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,11 +0,0 @@
# iframe-block
[English](./README.md) | 中文
Iframe 区块插件。
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1 +1,30 @@
# @nocobase/plugin-block-workbench
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,6 +1,30 @@
# calendar
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## Introduction
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,5 +0,0 @@
# 日历
[English](./README.md) | 中文
## 简介

View File

@ -1,9 +1,30 @@
# client
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# client
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1 +1,30 @@
# @nocobase/plugin-collection-sql
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1 +1,30 @@
# @nocobase/plugin-collection-tree
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +1,30 @@
# collection-manager
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# collection-manager
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1 +1,30 @@
# @nocobase/plugin-data-source-manager
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,88 +1,30 @@
# Data Visualization
# NocoBase
提供BI面板和数据可视化功能。
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 介绍
新版数据可视化插件以Collection为基础提供了可视化的数据检索、图表配置面板多个图表可以在同一区块内进行组织支持以插件形式扩展和使用其他图表组件库。未来还计划支持SQL模式单个及多个图表的时间、条件筛选数据下钻图表与数据区块联动等功能。
## What is NocoBase
## 图表区块
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
<img src="https://s2.loli.net/2023/06/30/vTKZt9EXxS4Im5L.png"/>
Homepage:
https://www.nocobase.com/
- 图表区块可以组织多个图表,区块中的图表可以像区块一样排列和拖拽。
- 区块标题可以编辑。
- 图表以Collection为基础新建图表时需要选定一个Collection.
- 有查看权限的Collection才可以用于配置图表否则将会在选项中被隐藏。
- 图表可以修改 (Configure), 复制 (Duplicate), 设置标题 (Edit block title).
Online Demo:
https://demo.nocobase.com/new
## 配置面板
Documents:
https://docs.nocobase.com/
<img src="https://s2.loli.net/2023/06/30/75GMbhCcypHitkE.png"/>
Commericial license & plugins:
https://www.nocobase.com/en/commercial
配置面板整体上分为三个区块:数据配置,图表配置,图表预览。
License agreement:
https://www.nocobase.com/en/agreement
### 数据配置
<img src="https://s2.loli.net/2023/06/30/34fnM7i6SIPJgFm.png" width="500" />
- 顶部下拉框代表当前正在配置的Collection通过下拉菜单可以切换。
- 配置完成后,点击"Run query"可以通过配置获取数据,"Data"面板会展示数据。
#### 度量
<img src="https://s2.loli.net/2023/06/30/xZwW6UR1klB4dCs.png" width="500" />
度量字段,通常是图表需要展示的核心数据。度量数据可以通过聚合函数进行统计,支持常用的数据库统计函数`Sum`, `Count`, `Avg`, `Max`, `Min`. 度量字段可以有多个,可以设置别名。
#### 维度
<img src="https://s2.loli.net/2023/06/30/2eAHvGojmlL1YtQ.png" width="500" />
维度字段通常是图表数据分组的依据。对于日期类型字段支持如图所示的格式化方式格式化通过数据库函数实现例如MySQL对应`date_format`),其他类型数据格式化见[数据转换](数据转换)部分。
> **维度格式化 (Dimensions Format) VS 数据转换 (Transform)**
> - 维度格式化发生在获取最终数据之前,数据分组按照维度格式化后的值进行,通常在按时间段筛选数据时有此需求。
> - 数据转换对响应数据做进一步处理,诸如可读性处理,以展现恰当的数据,数据转换在前端进行。
#### 筛选
<img src="https://s2.loli.net/2023/06/30/kvbHO5Y1fsiMm3E.png" width="500" />
此处配置将对分组前的数据进行过滤。
#### 排序 (Sort) 和限制 (Limit)
<img src="https://s2.loli.net/2023/06/30/HCpiQ4qATcLeKUE.png" width="500" />
目前图表允许的数据集条数上限为2000.
#### 缓存
<img src="https://s2.loli.net/2023/06/30/OY6JephtbcH4run.png" width="300" />
开启缓存后,图表将展示缓存的数据。
### 图表配置
<img src="https://s2.loli.net/2023/06/30/KHaPvYsBxh7plGQ.png" width="500" />
- 图表类型 (Chart Type) - 用于展示的图表类型,目前按图表库分组。如何使用其他图表库?
- 基础配置 - 选择图表后会出现相应的基础可视化配置字段配置通常提供了下拉菜单供选择选项中包含了Collection的基础字段和字段别名。
- JSON配置 - 当基础配置不满足要求时可以使用JSON配置其他图表属性。
### 数据转换
<img src="https://s2.loli.net/2023/06/30/yf82mYs6V1aCRIj.png" width="500" />
使用数据转换可以对接口响应的数据做进一步处理,目前支持转换处理的数据类型为 `number`, `date`, `time`, `datetime`, 对于不属于支持的数据类型的字段,可以手动选择为这几个类型,以使用对应的转换方法。
## 使用其他图表库
```TypeScript
import { ChartLibraryProvider } from '@nocobase/plugin-charts-v2/client';
```
图表插件提供了ChartLibraryProvider组件组件接收以下属性:
- name 图表库名字
- charts 图表组件列表,参考`packages/plugins/charts-v2/src/client/renderer/library/G2PlotLibrary.tsx`
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +1,30 @@
# error-handler
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# error-handler
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,11 +1,30 @@
# china-region
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
中国行政区划插件。
## 安装激活
## What is NocoBase
内置插件无需手动安装激活。
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## 使用方法
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,11 +0,0 @@
# china-region
[English](./README.md) | 中文
中国行政区划插件。
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,9 +1,30 @@
# Formula field
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# 公式字段
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1 +1,30 @@
# @nocobase/plugin-field-record-set
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1 +1,30 @@
# @nocobase/plugin-field-markdown-vditor
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +1,30 @@
# sequence-field
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# sequence-field
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,9 +1,30 @@
# file-manager
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# file-manager
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1 +1,30 @@
# @nocobase/plugin-gantt
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,11 +1,30 @@
# graph-collection-manager
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
```bash
yarn pm enable graph-collection-manager
```
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,11 +0,0 @@
# graph-collection-manager
[English](./README.md) | 中文
## 安装激活
```bash
yarn pm enable graph-collection-manager
```
## 使用方法

View File

@ -1 +1,30 @@
# @nocobase/plugin-kanban
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,35 +1,30 @@
# Localization Management
# NocoBase
支持管理应用程序的多语言资源。
## 使用方法
### 在`系统设置`中添加对应语言
<img src="https://s2.loli.net/2023/07/17/1t958NfkEyMjhsm.png" width="550" />
### 切换到对应语言
<img src="https://s2.loli.net/2023/07/17/npNT1EsIAQcGH3W.png" width="300" />
### 管理多语言资源
1. 同步需要翻译的原文内容
<img src="https://s2.loli.net/2023/07/17/3Uqzdt6mfvauDEP.png" width="300" />
- 目前支持的内容
- 菜单
- 系统和插件提供的语言包
- 数据表名、字段名、字段选项标签
> **Note**
> 新增菜单、数据表名、字段名、字段选项标签会自动同步
> 已有内容需要点击同步按钮手动同步
2. 编辑翻译内容,点击`发布`按钮即可生效
<img src="https://s2.loli.net/2023/07/17/TVzmJt6ZNYg4fSo.png" width="400" />
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1 +1,30 @@
# @nocobase/plugin-logger
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,13 +1,30 @@
# map
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
地图插件。
## 安装激活
## What is NocoBase
```bash
yarn pm enable map
```
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## 使用方法
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,13 +0,0 @@
# map
[English](./README.md) | 中文
地图插件。
## 安装激活
```bash
yarn pm enable map
```
## 使用方法

View File

@ -1,15 +1,30 @@
# Mobile
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
多应用管理插件。
## 安装激活
## What is NocoBase
```bash
yarn pm enable @nocobase/plugin-mobile
```
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## 文档
Homepage:
https://www.nocobase.com/
[使用文档](https://docs.nocobase.com/handbook/mobile)
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,15 +0,0 @@
# Mobile
[English](./README.md) | 中文
多应用管理插件。
## 安装激活
```bash
yarn pm enable @nocobase/plugin-mobile
```
## 文档
[使用文档](https://docs.nocobase.com/handbook/mobile)

View File

@ -0,0 +1,30 @@
# NocoBase
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## What is NocoBase
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,13 +1,30 @@
# multi-app-manager
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
多应用管理插件。
## 安装激活
## What is NocoBase
```bash
yarn pm enable multi-app-manager
```
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## 使用方法
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,13 +0,0 @@
# multi-app-manager
[English](./README.md) | 中文
多应用管理插件。
## 安装激活
```bash
yarn pm enable multi-app-manager
```
## 使用方法

View File

@ -1,9 +1,30 @@
# notifications
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# notifications
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,28 +1,30 @@
# Hello sample
# NocoBase
## Register
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
```ts
yarn pm add sample-hello
```
## Activate
## What is NocoBase
```bash
yarn pm enable sample-hello
```
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## Launch the app
Homepage:
https://www.nocobase.com/
```bash
# for development
yarn dev
Online Demo:
https://demo.nocobase.com/new
# for production
yarn build
yarn start
```
Documents:
https://docs.nocobase.com/
## Demo
Commericial license & plugins:
https://www.nocobase.com/en/commercial
[gif]
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,13 +1,30 @@
# snapshot-field
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
关系数据快照插件。
## 安装激活
## What is NocoBase
```bash
yarn pm enable snapshot-field
```
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## 使用方法
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,13 +0,0 @@
# snapshot-field
[English](./README.md) | 中文
关系数据快照插件。
## 安装激活
```bash
yarn pm enable snapshot-field
```
## 使用方法

View File

@ -1,9 +1,30 @@
# system-settings
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# system-settings
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,59 +1,30 @@
English | [中文](./README.zh-CN.md)
# NocoBase
# Theme Editor
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
> Note: The current theme feature is implemented based on antd 5.x version. It is recommended to read about the [Customizing Theme](https://ant.design/docs/react/customize-theme#%E8%87%AA%E5%AE%9A%E4%B9%89%E4%B8%BB%E9%A2%98) concept before proceeding with this document.
## Introduction
## What is NocoBase
The plugin is essentially a tool for modifying the style of the entire front-end page. It currently supports editing global [SeedToken](https://ant.design/docs/react/customize-theme#seedtoken), [MapToken](https://ant.design/docs/react/customize-theme#maptoken), and [AliasToken](https://ant.design/docs/react/customize-theme#aliastoken), as well as enabling a [switch](https://ant.design/docs/react/customize-theme#%E4%BD%BF%E7%94%A8%E9%A2%84%E8%AE%BE%E7%AE%97%E6%B3%95) to Dark Mode and Compact Mode. In the future, it may support [component-level](https://ant.design/docs/react/customize-theme#%E4%BF%AE%E6%94%B9%E7%BB%84%E4%BB%B6%E5%8F%98%E9%87%8F-component-token) theme customization.
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
## User Guide
Homepage:
https://www.nocobase.com/
### Enabling The Theme Plugin
Online Demo:
https://demo.nocobase.com/new
Firstly, update NocoBase to the latest version (v0.11.1 or above). Then, search for the `Theme Editor` card in the `Plugin Management` Page. Click on the Enable button at the bottom right of the card and wait for the page to refresh.
Documents:
https://docs.nocobase.com/
![20240409132838](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409132838.png)
Commericial license & plugins:
https://www.nocobase.com/en/commercial
### Navigate to the Theme Configuration Page
License agreement:
https://www.nocobase.com/en/agreement
After enabling, click on the settings button at the bottom left of the card, and you will be redirected to the theme editing page. By default, there are four theme options: `Default Theme`, `Dark Theme`, `Compact Theme`, and `Compact Dark Theme`.
![20240409133020](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133020.png)
## Adding a New Theme
Click the `Add New Theme` button and choose `Create a Brand New Theme`. A Theme Editor will pop up on the right side of the page, allowing you to edit Colors, Sizes, Styles, and more. After editing, enter a theme name and click save to add the new theme.
![20240409133147](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133147.png)
## Applying the New Theme
You can move the mouse to the top right corner of the page, where you will see a theme switcher. Clicking on it allows you to switch to other themes, such as the newly added theme.
![20240409133247](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133247.png)
## Editing an Existing Theme
Click the `Edit` button at the bottom left of the card. Similar to adding a new theme, a Theme Editor will pop up on the right side of the page. After editing, click save to complete the theme modification.
![20240409134413](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409134413.png)
## User Options for Theme Switching
Newly added themes are by default available for users to switch to. If you do not want users to switch to a certain theme, you can turn off the `User selectable` switch at the bottom right of the theme card, making it unavailable for users to choose.
![20240409133331](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133331.png)
## Setting as Default Theme (The Default Theme Cannot Be Deleted)
Initially, the `Default Theme` is set as the default. If you want to set a specific theme as the new default, switch on the `Default Theme` toggle at the bottom right of the card. This will ensure that when users open the page for the first time, they will be presented with this theme.
![20240409133409](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133409.png)
## Deleting a Theme
Click on the Delete button below the card, then click on the confirmation button that pops up to remove the theme.
![20240409133435](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133435.png)
## Contact Us:
hello@nocobase.com

View File

@ -1,59 +0,0 @@
[English](./README.md) | 中文
# 主题编辑器
> 当前主题功能是在 antd 5.x 版本的基础上实现的,所以在阅读本文之前最好先阅读一下[定制主题](https://ant.design/docs/react/customize-theme-cn#%E8%87%AA%E5%AE%9A%E4%B9%89%E4%B8%BB%E9%A2%98)相关的概念。
## 介绍
可以简单理解为该插件就是用来修改整个前端页面的样式的。目前支持编辑全局范围的 [SeedToken](https://ant.design/docs/react/customize-theme-cn#seedtoken)、[MapToken](https://ant.design/docs/react/customize-theme-cn#maptoken)、[AliasToken](https://ant.design/docs/react/customize-theme-cn#aliastoken),和支持[切换](https://ant.design/docs/react/customize-theme-cn#%E4%BD%BF%E7%94%A8%E9%A2%84%E8%AE%BE%E7%AE%97%E6%B3%95)为 `暗黑模式``紧凑模式`。后期有可能会支持[组件级别](https://ant.design/docs/react/customize-theme-cn#%E4%BF%AE%E6%94%B9%E7%BB%84%E4%BB%B6%E5%8F%98%E9%87%8F-component-token)的主题定制。
## 使用说明
### 启用主题插件
首先把 NocoBase 更新到最新版本v0.11.1 及以上),然后在 `插件管理页面` 搜索 `主题编辑器` 的卡片,点击卡片右下角的 `启用` 按钮等待页面刷新。
![20240409132838](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409132838.png)
### 跳转到主题配置页面
启用之后点击卡片左下角的设置按钮,会跳转到主题编辑页面。默认会有四个主题选项,分别是 `默认主题``暗黑主题``紧凑主题``紧凑暗黑主题`
![20240409133020](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133020.png)
## 新增一个主题
点击 `添加新主题` 按钮,选择 `新增一个全新的主题`,然后会在页面右侧弹出一个 `主题编辑器`,支持编辑 `颜色``尺寸``风格`等。编辑好之后输入主题名称然后点击保存即可完成主题的新增。
![20240409133147](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133147.png)
## 应用新主题
可以把鼠标移到页面右上角,可以看到一个主题切换项,点击可以切换到其他主题,比如可以切换刚才新增的主题。
![20240409133247](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133247.png)
## 编辑已经存在的主题
点击卡片左下角的 `编辑` 按钮,如同新增主题一样,会在页面右侧弹出一个 `主题编辑器`,编辑好之后点击保存即可完成主题的编辑。
![20240409134413](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409134413.png)
## 用户切换主题时的可选项
新添加的主题默认是允许用户切换的,如果不想让用户切换到某个主题,可以关闭主题卡片右下角的 `可被用户选择` 开关,这样用户就无法切换到该主题了。
![20240409133331](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133331.png)
## 设置为默认主题(默认主题不可删除)
在初始状态下,默认主题是 `默认主题`,如果想把某个主题设置为默认主题,可以开启卡片右下角的 `默认主题` 开关,这样当用户第一次打开页面时看到的就是该主题。
![20240409133409](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133409.png)
## 删除主题
点击卡片下方的 `删除` 按钮,然后点击弹出的确认按钮即可删除主题。
![20240409133435](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20240409133435.png)

View File

@ -1,9 +1,30 @@
# ui-schema-storage
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# ui-schema-storage
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,9 +1,30 @@
# users
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# users
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,9 +1,30 @@
# verification
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# verification
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,9 +1,30 @@
# workflow
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# workflow
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

View File

@ -1,9 +1,30 @@
# workflow
# NocoBase
English | [中文](./README.zh-CN.md)
<video width="100%" controls>
<source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
</video>
## 安装激活
内置插件无需手动安装激活。
## What is NocoBase
## 使用方法
NocoBase is a scalability-first, open-source no-code development platform.
Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
Homepage:
https://www.nocobase.com/
Online Demo:
https://demo.nocobase.com/new
Documents:
https://docs.nocobase.com/
Commericial license & plugins:
https://www.nocobase.com/en/commercial
License agreement:
https://www.nocobase.com/en/agreement
## Contact Us:
hello@nocobase.com

View File

@ -1,9 +0,0 @@
# workflow
[English](./README.md) | 中文
## 安装激活
内置插件无需手动安装激活。
## 使用方法

Some files were not shown because too many files have changed in this diff Show More