From 58e2ac3f5cd1e5f93f5d5d2de95e72313850ff57 Mon Sep 17 00:00:00 2001 From: chenos Date: Wed, 7 Apr 2021 20:34:30 +0800 Subject: [PATCH] docs: installation instructions --- README.md | 19 +++++++++++++++++++ README.zh-CN.md | 19 +++++++++++++++++++ 2 files changed, 38 insertions(+) diff --git a/README.md b/README.md index 88dd90d8ad..5e49bd7406 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,25 @@ Database(Choose any one): 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 # You can use docker to start the database docker-compose up -d postgres diff --git a/README.zh-CN.md b/README.zh-CN.md index 9d2b45a6b7..8f4187c057 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -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 git clone https://github.com/nocobase/nocobase.git cd nocobase