diff --git a/README.md b/README.md index 2e86551340..76b0800c8d 100644 --- a/README.md +++ b/README.md @@ -57,26 +57,33 @@ Architecture ![](https://nocobase.oss-cn-beijing.aliyuncs.com/4fde069587182dacbdb00b020d914404.jpg) -Development +Requirements ---------- -Install Dependencies - -~~~shell -# Install dependencies for root project -npm i - -# Install dependencies for sub packages via lerna -npm run bootstrap -~~~ - -Set Environment Variables +Node: + +- Node.js 12.x or 14.x + +Database: + +- PostgreSQL 10.x+ +- MySQL 5.7.x+ + +Installation +---------- ~~~shell +# Set Environment Variables cp .env.example .env +npm install +npm run bootstrap +npm run build +npm run db-migrate init +npm start ~~~ Build +---------- ~~~shell # for all packages @@ -87,6 +94,7 @@ npm run build ... ~~~ Test +---------- ~~~ # For all packages diff --git a/README.zh-CN.md b/README.zh-CN.md index 0b59c2dc1b..b5b4239080 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -82,26 +82,34 @@ NocoBase 采用微内核架构,框架只保留核心的概念,具体各类 - 保存在文件里,多用于系统表配置或纯开发配置 - 保存在数据表里,多用于业务表配置 -Development +环境要求 ---------- -Install Dependencies +Node: + +- Node.js 12.x or 14.x + +Database: + +- PostgreSQL 10.x+ +- MySQL 5.7.x+ + +安装 & 运行 +---------- ~~~shell -# Install dependencies for root project -npm i - -# Install dependencies for sub packages via lerna +git clone https://github.com/nocobase/nocobase.git +cd nocobase +cp .env.example .env # 配置数据库信息、APP 端口等 +npm install npm run bootstrap +npm run build +npm run db-migrate init +npm start ~~~ -Set Environment Variables - -~~~shell -cp .env.example .env -~~~ - -Build +打包 +---------- ~~~shell # for all packages @@ -111,7 +119,8 @@ npm run build npm run build ... ~~~ -Test +测试 +---------- ~~~ # For all packages