mirrors/nocobase
1
0
Fork 0
mirror of https://github.com/nocobase/nocobase synced 2024-11-15 05:25:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
1,365 Commits 93 Branches 321 Tags 223 MiB
TypeScript 98.8%
JavaScript 1.1%
d5a0f36e92
Go to file
Zhou d5a0f36e92
Update README.zh-CN.md
2022-04-27 18:22:41 +08:00
.github/workflows fix: through table primaryKey error (#297) 2022-04-19 16:35:44 +08:00
docker fix: create-nocobase-app client package version (#321) 2022-04-25 22:05:05 +08:00
docs feat: client v0.6 (#150) 2022-01-10 19:22:21 +08:00
packages fix: cannot find module mkdirp (#330) 2022-04-27 12:27:31 +08:00
.editorconfig Feat: client base entry of plugin workflow (#225) 2022-03-27 15:51:48 +08:00
.env.example Feat/create nocobase app (#273) 2022-04-17 10:00:42 +08:00
.eslintignore v0.6 2021-12-06 21:23:34 +08:00
.eslintrc v0.5 2021-05-23 08:38:08 +08:00
.gitignore feat: details block (#302) 2022-04-20 15:49:01 +08:00
.prettierignore v0.6 2021-12-06 21:23:34 +08:00
.prettierrc refactor: code splitting of the table component (#121) 2021-12-02 22:56:16 +08:00
.umirc.ts feat: client v0.6 (#150) 2022-01-10 19:22:21 +08:00
commitlint.config.js fix(root): change wrong file mode 2022-04-23 23:26:19 +08:00
docker-compose.yml feat: junction collection for linkTo field (#296) 2022-04-18 18:57:21 +08:00
jest.cli.js feat: rename ui_schemas to uiSchemas 2022-02-16 00:22:47 +08:00
jest.config.js chore(jest): modulePathIgnorePatterns 2022-02-15 11:02:56 +08:00
jest.setup.ts feat: error handle middleware (#214) 2022-03-02 12:50:15 +08:00
lerna.json chore(versions): 😊 publish v0.7.0-alpha.15 2022-04-26 22:32:06 +08:00
LICENSE feat(license): replace MIT license with Apache-2.0 2022-04-25 09:45:24 +08:00
package.json chore: dotenv with pm2 2022-04-26 22:30:46 +08:00
publish.js Fix multiple apps (#316) 2022-04-24 20:22:50 +08:00
README.md Update README.md 2022-04-27 08:01:13 +08:00
README.zh-CN.md Update README.zh-CN.md 2022-04-27 18:22:41 +08:00
tsconfig.build.json feat: client v0.6 (#150) 2022-01-10 19:22:21 +08:00
tsconfig.jest.json Feat/create nocobase app (#273) 2022-04-17 10:00:42 +08:00
tsconfig.json Feat/create nocobase app (#273) 2022-04-17 10:00:42 +08:00
yarn.lock fix: cannot find module mkdirp (#330) 2022-04-27 12:27:31 +08:00

README.md

English | 中文

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

Why choose NocoBase

  • Open source and free
    • Unrestricted commercial use under the Apache-2.0 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
    • Data Model
      • Dozens of field types such as text, attachments, etc., as well as many-to-many, one-to-many, one-to-one relationships.
    • Menu
      • Groups, pages, links combination into menu, support infinite level submenu
    • Block
      • Rich block types such as tables, kanban, calendars, forms, etc. are freely combined within the page to display and manipulate data.
    • Action
      • Configure actions such as filtering, exporting, adding, deleting, modifying, and viewing to process data.
    • ACL
      • Role-based control of user's system configuration rights, action rights and menu access rights.
    • Workflow
      • Repetitive tasks are replaced by automation, reducing manual operations and increasing efficiency.
  • 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

Architecture

Requirements

Node:

  • Node.js 12.20+

Database:

  • PostgreSQL 10.x+
  • MySQL 8.x+
  • SQLite 3+

Installation

Create a project with create-nocobase-app

# 1. create project
# SQLite
yarn create nocobase-app my-nocobase-app -d sqlite
# MySQL
yarn create nocobase-app my-nocobase-app -d mysql \
   -e DB_HOST=mysql \
   -e DB_PORT=3356 \
   -e DB_DATABASE=nocobase \
   -e DB_USER=nocobase \
   -e DB_PASSWORD=nocobase
# PostgreSQL
yarn create nocobase-app my-nocobase-app -d postgres \
   -e DB_HOST=postgres \
   -e DB_PORT=5432 \
   -e DB_DATABASE=postgres \
   -e DB_USER=postgres \
   -e DB_PASSWORD=postgres

# 2. switch to the project directory
cd my-nocobase-app

# 3. Install dependencies
yarn install

# 4. Install NocoBase
yarn nocobase install --lang=en-US

# 5. start project
yarn start

Open 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
# 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

Building

# For all packages
yarn build

# For specific package
yarn build --scope @nocobase/database

Testing

# For all packages
yarn test

# For specific package
yarn test packages/<name>