mirror of
https://github.com/nocobase/nocobase
synced 2024-11-16 08:26:24 +00:00
796e73ae5a
* refactor(doc): change to new structure * docs: add database docs * docs: add collection docs * docs: add db field examples * docs(api): fix filename and menu path * docs: add database docs * docs: add db operators doc * docs: add resourcer menu * docs: add resourcer docs * docs: fix api docs * docs: refactor api menu structure * feat: update docs (#830) * feat: updates * feat: update docs * chore: ignore docs from ci Co-authored-by: Junyi <mytharcher@users.noreply.github.com> Co-authored-by: mytharcher <mytharcher@gmail.com> * docs: add database methods docs * docs: add missed api * docs: fix api docs * feat: update development docs (#833) * feat: update development docs * feat: update docs * feat: update docs * docs: add first plugin example (#834) * feat: update docs * feat: update docs * docs: fix typo Co-authored-by: chenos <chenlinxh@gmail.com>
47 lines
711 B
Markdown
47 lines
711 B
Markdown
# 贡献
|
|
|
|
- Fork 源代码到自己的仓库
|
|
- 修改源代码
|
|
- 提交 Pull Request
|
|
|
|
## 下载项目
|
|
|
|
```bash
|
|
# 替换为自己的仓库地址
|
|
git clone https://github.com/nocobase/nocobase.git
|
|
cd nocobase
|
|
yarn install
|
|
```
|
|
|
|
## 应用开发与测试
|
|
|
|
```bash
|
|
# 安装并启动应用
|
|
yarn dev
|
|
# 运行所有测试
|
|
yarn test
|
|
# 运行文件夹下所有测试文件
|
|
yarn test <dir>
|
|
# 运行单个测试文件
|
|
yarn test <file>
|
|
```
|
|
|
|
## 文档预览
|
|
|
|
```bash
|
|
# 启动文档
|
|
yarn doc --lang=zh-CN
|
|
yarn doc --lang=en-US
|
|
```
|
|
|
|
文档在 docs 目录下，遵循 Markdown 语法
|
|
|
|
```bash
|
|
|- /docs/
|
|
|- en-US
|
|
|- zh-CN
|
|
```
|
|
|
|
## 其他
|
|
|
|
更多 Commands 使用说明 [参考 NocoBase CLI 章节](./development/nocobase-cli.md) |