docs: installation instructions

This commit is contained in:
chenos 2021-04-07 20:34:30 +08:00
parent ef93a3c11c
commit 58e2ac3f5c
2 changed files with 38 additions and 0 deletions

View File

@ -72,6 +72,25 @@ Database(Choose any one):
Installation Installation
---------- ----------
Use only as a no-code platform
~~~bash
# Create project directory
mkdir my-nocobase-project && cd my-nocobase-project
# npm initialization
npm init
# Installing nocobase dependencies
npm i @nocobase/api @nocobase/app
# Copy and configure env, don't forget to change the database information
cp -r node_modules/@nocobase/api/.env.example .env
# Database initialization
npx nocobase db-init
# Start app
npx nocobase start
~~~
Want to participate in the development
~~~shell ~~~shell
# You can use docker to start the database # You can use docker to start the database
docker-compose up -d postgres docker-compose up -d postgres

View File

@ -97,6 +97,25 @@ Database:
安装 & 运行 安装 & 运行
---------- ----------
仅作为无代码平台使用
~~~shell
# 创建项目目录
mkdir my-nocobase-project && cd my-nocobase-project
# 初始化 npm
npm init
# 安装 nocobase 包
npm i @nocobase/api @nocobase/app
# 复制并配置 env不要忘了修改数据库信息
cp -r node_modules/@nocobase/api/.env.example .env
# 数据库初始化
npx nocobase db-init
# 启动应用
npx nocobase start
~~~
想要参与项目开发
~~~shell ~~~shell
git clone https://github.com/nocobase/nocobase.git git clone https://github.com/nocobase/nocobase.git
cd nocobase cd nocobase