docs: installation

This commit is contained in:
chenos 2021-03-30 20:27:01 +08:00
parent 50f1d1853b
commit 981f86dc68
2 changed files with 43 additions and 26 deletions

View File

@ -57,26 +57,33 @@ Architecture
![](https://nocobase.oss-cn-beijing.aliyuncs.com/4fde069587182dacbdb00b020d914404.jpg) ![](https://nocobase.oss-cn-beijing.aliyuncs.com/4fde069587182dacbdb00b020d914404.jpg)
Development Requirements
---------- ----------
Install Dependencies Node:
~~~shell - Node.js 12.x or 14.x
# Install dependencies for root project
npm i Database:
# Install dependencies for sub packages via lerna - PostgreSQL 10.x+
npm run bootstrap - MySQL 5.7.x+
~~~
Installation
Set Environment Variables ----------
~~~shell ~~~shell
# Set Environment Variables
cp .env.example .env cp .env.example .env
npm install
npm run bootstrap
npm run build
npm run db-migrate init
npm start
~~~ ~~~
Build Build
----------
~~~shell ~~~shell
# for all packages # for all packages
@ -87,6 +94,7 @@ npm run build <package_name_1> <package_name_2> ...
~~~ ~~~
Test Test
----------
~~~ ~~~
# For all packages # For all packages

View File

@ -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 ~~~shell
# Install dependencies for root project git clone https://github.com/nocobase/nocobase.git
npm i cd nocobase
cp .env.example .env # 配置数据库信息、APP 端口等
# Install dependencies for sub packages via lerna npm install
npm run bootstrap npm run bootstrap
npm run build
npm run db-migrate init
npm start
~~~ ~~~
Set Environment Variables 打包
----------
~~~shell
cp .env.example .env
~~~
Build
~~~shell ~~~shell
# for all packages # for all packages
@ -111,7 +119,8 @@ npm run build
npm run build <package_name_1> <package_name_2> ... npm run build <package_name_1> <package_name_2> ...
~~~ ~~~
Test 测试
----------
~~~ ~~~
# For all packages # For all packages