Skip to content

Commit

Permalink
feat: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chenos committed Oct 30, 2023
1 parent ef9d0c9 commit 513ea56
Show file tree
Hide file tree
Showing 213 changed files with 99 additions and 4,324 deletions.
956 changes: 13 additions & 943 deletions docs/config.ts

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/en-US/welcome/introduction/features.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Why NocoBase is different
# Distinctive features

## 1. Separate "data structure" and "user interface"
## 1. Model-driven, separate "user interface" from "data structure"

Most form-, table-, or process-driven codeless products create data structures directly in the user interface, such as Airtable, where adding a new column to a table is adding a new field. This has the advantage of simplicity of use, but the disadvantage of limited functionality and flexibility to meet the needs of more complex scenarios.
Most form-, table-, or process-driven no-code products create data structures directly in the user interface, such as Airtable, where adding a new column to a table is adding a new field. This has the advantage of simplicity of use, but the disadvantage of limited functionality and flexibility to meet the needs of more complex scenarios.

NocoBase adopts the design idea of separating the data structure from the user interface, allowing you to create any number of blocks (data views) for the data collections, with different type, styles, content, and actions in each block. This takes into account the simplicity of codeless operation, but also the flexibility like native development.
NocoBase adopts the design idea of separating the data structure from the user interface, allowing you to create any number of blocks (data views) for the data collections, with different type, styles, content, and actions in each block. This balances the simplicity of no-code operation with the flexibility of native development.

![2.collection-block.png](./features/2.collection-block.png)
![model](https://nocobase-file.oss-cn-beijing.aliyuncs.com/model-l.png)

## 2. What you see is what you get

NocoBase enables the development of complex and distinctive business systems, but this does not mean that complex and specialized operations are required. With a single click, configuration options can be displayed on the usage interface, which means that administrators with system configuration rights can configure the user interface directly with WYSIWYG operations.
NocoBase enables the development of complex and distinctive business systems, but this does not mean that complex and specialized operations are required. With a single click, configuration options are displayed on the usage interface, and administrators with system configuration privileges can directly configure the user interface in a WYSIWYG manner.

![2.user-root.gif](./features/2.user-root.gif)
![wysiwyg](https://nocobase-file.oss-cn-beijing.aliyuncs.com/wysiwyg.gif)

## 3. Everything is a plugin
## 3. Functions as plugins

NocoBase adopts plugin architecture, all new features can be implemented by developing and installing plugins. In the future, we will build a plug-in marketplace where extending functionality is as easy as installing an APP on your phone.
NocoBase adopts plugin architecture, all new functions can be realized by developing and installing plugins, and expanding the functions is as easy as installing an APP on your phone.

![](https://www.nocobase.com/images/NocoBaseMindMapLite.png)
![plugins](https://nocobase-file.oss-cn-beijing.aliyuncs.com/plugins-l.png)
46 changes: 10 additions & 36 deletions docs/en-US/welcome/introduction/index.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,28 @@
# Introduction

![](https://nocobase.oss-cn-beijing.aliyuncs.com/bbcedd403d31cd1ccc4e9709581f5c2f.png)
![NocoBase](https://nocobase-file.oss-cn-beijing.aliyuncs.com/main-l.png)

**Note:** 📌

NocoBase is in early stage of development and is subject to frequent changes, please use caution in production environments.

## What is NocoBase

NocoBase is a scalability-first, open-source no-code development platform. No programming required, build your own collaboration platform, management system with NocoBase in hours.
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:
Homepage:
https://www.nocobase.com/

Online Demo:
Online Demo:
https://demo.nocobase.com/new

Contact Us:
Documents:
https://docs.nocobase.com/

Contact Us:
[email protected]

## Features

- **Open source and free**
- Apache-2.0 & AGPL-3.0 licensed
- Full code ownership, private deployment, private and secure data
- Free to expand and develop for actual needs
- Good ecological support
- **Strong no-code capability**
- Data Model
- Create independent data models using dozens of field types such as text, number, attachment, and various association relationships such as one-to-one, one-to-many, etc.
- Block
- Display and manipulate data within a page using a free combination of block types such as tables, forms, kanban, calendars, details, etc.
- Action
- Support filtering, exporting, adding, deleting, modifying, viewing and other operations to process data, which can be extended to more types.
- ACL
- Role-based control of user's system configuration rights, data action rights and menu access rights.
- Workflow
- Repetitive tasks are replaced by automation to increase efficiency. Manual approval is required for important matters.
- **Built for extended development**
- Microkernel architecture, flexible and easy to extend, with a robust plug-in system
- Node.js-based, with popular frameworks and technologies, including Koa, Sequelize, React, Formily, Ant Design, etc.
- 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

## Architecture

![](https://www.nocobase.com/images/NocoBaseMindMapLite.png)

[Click here to view the full image](https://www.nocobase.com/images/NocoBaseMindMap.png)

## Business Services
## Commercial Version & Business Services

If you need commercial version and commercial services, please feel free to contact us by email: [email protected]
10 changes: 0 additions & 10 deletions docs/en-US/welcome/introduction/when.md

This file was deleted.

25 changes: 25 additions & 0 deletions docs/en-US/welcome/introduction/why.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Why NocoBase

## Open source, autonomous and controllable

NocoBase is open source under the Apache-2.0 & AGPL-3.0 licenses, and can be used free of charge as long as you follow the licenses. Advanced features are provided through the commercial version, which also provides full source code and is privately deployed to keep data private and secure.

## Strong no-code capability

NocoBase has three core concepts: collection, block, and action. By defining the data collections, to abstract the business; through the block to present the data; through the action to send the user's instructions to the server to complete the data interaction or change.

## High scalability

In the actual business, the ideal situation is to use no-code to meet 80% of the needs, the rest usually need to extend the development. NocoBase adopts the microkernel architecture, with a sound plugin system, all kinds of functions are extended in the form of plugins. NocoBase is based on Node.js and uses mainstream frameworks and technologies, including Koa, Sequelize, React and so on, which makes it extremely easy to expand.

## Integrate with existing systems

Organizations usually have various systems and databases already in place, and NocoBase supports using third-party databases or APIs as data sources, as well as embedding NocoBase into third-party systems or embedding third-party systems into NocoBase.

## Extremely simple and lightweight

NocoBase uses JavaScript/TypeScript technology stack, one person can complete the front-end and back-end development. It has low server requirements and can be deployed on a single low-configuration server.

## Pay once, use forever

NocoBase only charges for premium features. For a one-time fee, you get access to the full source code and 1 year of upgrade rights and technical support. After the expiration date, if you do not renew your subscription, you can stay in the current version and use it for free forever.
1 change: 0 additions & 1 deletion docs/zh-CN/manual/modules/ui/menus.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/zh-CN/manual/modules/ui/pages.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/zh-CN/manual/quick-start/the-first-app.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 第一个应用
# 第一个 APP

让我们用 NocoBase 搭建一个订单管理系统。

Expand Down
5 changes: 0 additions & 5 deletions docs/zh-CN/plugins/acl/index.md

This file was deleted.

Loading

0 comments on commit 513ea56

Please sign in to comment.