24ea83f0ff
* create-nocobase-app template from [develop] * change create-nocobase-app package.json config * feat: load configuration from directory * feat: configuration repository toObject * feat: create application from configuration dir * feat: application factory with plugins options * export type * feat: read application config & application with plugins options * feat: release command * fix: database release * chore: workflow package.json * feat: nocobase cli package * feat: console command * chore: load application in command * fix: load packages from process.cwd * feat: cli load env file * feat: create-nocobase-app * fix: gitignore create-nocobase-app lib * fix: sqlite path * feat: create plugin * chore: plugin files template * chore: move cli into application * chore: create-nocobase-app * fix: create plugin * chore: app-client && app-server * chore: package.json * feat: create-nocobase-app download template from npm * chore: create-nocobase-app template * fix: config of plugin-users * fix: yarn.lock * fix: database build error * fix: yarn.lock * fix: resourcer config * chore: cross-env * chore: app-client dependents * fix: env * chore: v0.6.0-alpha.1 * chore: verdaccio * chore(versions): 😊 publish v0.6.0 * chore(versions): 😊 publish v0.6.1-alpha.0 * chore(versions): 😊 publish v0.6.2-alpha.0 * chore(versions): 😊 publish v0.6.2-alpha.1 * chore: 0.6.2-alpha.2 * feat: workspaces * chore(versions): 😊 publish v0.6.2-alpha.3 * chore(versions): 😊 publish v0.6.2-alpha.4 * chore: create-nocobase-app * chore: create-nocobase-app lib * fix: update tsconfig.jest.json * chore: .env * chore(versions): 😊 publish v0.6.2-alpha.5 * chore(versions): 😊 publish v0.6.2-alpha.6 * feat: improve code * chore(versions): 😊 publish v0.6.2-alpha.7 * fix: cleanup * chore(versions): 😊 publish v0.6.2-alpha.8 * chore: tsconfig for app server package * fix: move files * fix: move files Co-authored-by: chenos <chenlinxh@gmail.com>
124 lines
3.4 KiB
Markdown
124 lines
3.4 KiB
Markdown
English | [简体中文](./README.zh-CN.md)
|
|
|
|
|
|
|
|
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 minutes.
|
|
|
|
Homepage:
|
|
https://www.nocobase.com/
|
|
|
|
Online Demo:
|
|
https://demo.nocobase.com/new
|
|
|
|
Contact Us:
|
|
hello@nocobase.com
|
|
|
|
When to use NocoBase
|
|
----------
|
|
- **SMEs and organizations build business platforms and management systems for themselves or for their industry**
|
|
- Want the price to be low enough or even free
|
|
- Can be flexibly customized without programming knowledge
|
|
- Need full control of source code and data
|
|
- Can freely distribute and sell as their own products
|
|
- **Service providers and outsourcing teams develop collaboration platforms and management systems for their clients**
|
|
- Want to keep development costs as low as possible
|
|
- Need the most user-friendly secondary development experience
|
|
- Must be deployed privately as a standalone product for the client
|
|
- Can be freely distributed and sold by the client
|
|
|
|
Why choose NocoBase
|
|
----------
|
|
- **Open source and free**
|
|
- Unrestricted commercial use under the MIT license
|
|
- Full code ownership, private deployment, private and secure data
|
|
- Free to expand and develop for actual needs
|
|
- Good ecological support
|
|
- **Strong no-code capability**
|
|
- WYSIWYG visual configuration
|
|
- Separation of data structure configuration from interface configuration
|
|
- Rich combination of blocks and operations
|
|
- Role-based access control
|
|
- **Developer-friendly**
|
|
- 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
|
|
|
|
Note
|
|
----------
|
|
NocoBase is still in early development and is for preview purposes only and is not suitable for use in a production environment. A relatively stable and well-documented public beta is expected to be released as early as the first quarter of 2022.
|
|
If you are interested in NocoBase, please join us to discuss and develop it together.
|
|
|
|
Architecture
|
|
----------
|
|
|
|
|
|
|
|
Requirements
|
|
----------
|
|
|
|
Node:
|
|
|
|
- Node.js 12.20+
|
|
|
|
Database:
|
|
|
|
- PostgreSQL 10.x+
|
|
- Mysql 8.x+
|
|
- Sqlite 3+
|
|
|
|
Installation
|
|
----------
|
|
|
|
## Create a project with `create-nocobase-app`
|
|
|
|
~~~shell
|
|
# 1. create project
|
|
yarn create nocobase-app my-nocobase-app
|
|
|
|
# 2. switch to the project directory
|
|
cd my-nocobase-app
|
|
|
|
# 3. create initialization data
|
|
yarn nocobase install --lang=en-US
|
|
|
|
# 4. start project
|
|
yarn start
|
|
~~~
|
|
|
|
Open [http://localhost:8000](http://localhost:8000) in a web browser. The initial account and password are `admin@nocobase.com` and `admin123`.
|
|
|
|
## Contributing
|
|
|
|
- Fork the source code to your own repository
|
|
- Modify source code
|
|
- Submit pull request
|
|
|
|
```bash
|
|
# Replace the following git address with your own repo
|
|
git clone https://github.com/nocobase/nocobase.git
|
|
cd nocobase
|
|
cp .env.example .env
|
|
yarn install
|
|
yarn nocobase install
|
|
yarn start
|
|
```
|
|
|
|
### Build
|
|
|
|
```bash
|
|
yarn build
|
|
```
|
|
|
|
### Test
|
|
|
|
```bash
|
|
# For all packages
|
|
yarn test
|
|
|
|
# For specific package
|
|
yarn test packages/<name>
|
|
```
|