From 4d307e071e171d1e26d2b34043463006f68911c0 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Tue, 25 Jan 2022 18:48:53 +0800 Subject: [PATCH] docs: revise chinese readme based on latest english version Signed-off-by: Wing-Kam Wong --- scripts/markdown/readme/languages/chinese.md | 106 +++++++------------ 1 file changed, 38 insertions(+), 68 deletions(-) diff --git a/scripts/markdown/readme/languages/chinese.md b/scripts/markdown/readme/languages/chinese.md index 23181c870a..9a374f6995 100644 --- a/scripts/markdown/readme/languages/chinese.md +++ b/scripts/markdown/readme/languages/chinese.md @@ -3,7 +3,6 @@ NocoDB
✨ Airtable 的开源替代品 ✨
-

将 MySQL、PostgreSQL、SQL Server、SQLite 或 MariaDB 转换为智能电子表格。 @@ -12,7 +11,7 @@ [![Build Status](https://travis-ci.org/dwyl/esta.svg?branch=master)](https://travis-ci.com/github/NocoDB/NocoDB) [![Node version](https://badgen.net/npm/node/next)](http://nodejs.org/download/) -[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/NocoDB.svg?style=social&label=Follow%20%40NocoDB)](https://twitter.com/NocoDB) +[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org) @@ -28,8 +27,9 @@ -NocoDB - The Open Source Airtable alternative | Product Hunt - +

+ NocoDB - The Open Source Airtable alternative | Product Hunt +

# 快速尝试 ### 一键式部署 @@ -110,10 +110,34 @@ npm start ![11](https://user-images.githubusercontent.com/86527202/136066756-fc203c2c-570e-4514-b9f4-2a41ac24e5dd.png)
- - - - +- [快速尝试](#quick-try) + + [一键式部署](#1-click-deploy) + - [Heroku](#heroku) + + [使用 Docker](#using-docker) + + [使用 Npm](#using-npm) + + [使用 Git](#using-git) + + [GUI](#gui) +- [加入我们的社区](#join-our-community) +- [截图](#screenshots) +- [特征](#features) + + [丰富的电子表格功能](#rich-spreadsheet-interface) + + [工作流自动化应用商店](#app-store-for-workflow-automations) + + [Programmatic API访问通过](#programmatic-api-access-via) +- [生产安装](#production-setup) + * [Docker](#docker) + - [示例: MySQL](#example--mysql) + - [示例: PostgreSQL](#example--postgresql) + - [示例: SQL Server](#example--sql-server) + * [Docker Compose](#docker-compose) + * [环境变量](#environment-variables) +- [开发安装](#development-setup) + * [Cloning the project](#clone-the-project) + * [在本地运行 Backend 测试](#running-backend-locally) + * [在本地运行 Frontend 测试](#running-frontend-locally) + * [在本地运行 Cypress 测试](#running-cypress-tests-locally) +- [贡献](#contributing) +- [为什么我们建立这个?](#why-are-we-building-this) +- [我们的任务](#our-mission) # 特征 ### 丰富的电子表格功能 @@ -139,7 +163,6 @@ npm start - ⚡ JWT身份验证和社交验证 - ⚡ 与Zapier，Integromat集成的API - # 生产安装 NoCodb 要求一个数据库用来存储电子表格视图和外部元数据。可以在`NC_DB`环境变量中指定此数据库的连接参数。 @@ -177,75 +200,22 @@ cd mysql or pg or mssql docker-compose up ``` - ## 环境变量 -| 变量 | 强制 | 注释 | 缺省 | -|-------------------------|-----------|----------------------------------------------------------------------------------|--------------------------------------------| -| NC_DB | Yes | 查看我们的数据库 URL | 将在根文件夹中创建一个本地 SQLite 文件 | -| DATABASE_URL | No | JDBC URL 格式。 可以代替 NC_DB 使用。 用于一键式 Heroku 部署| | -| DATABASE_URL_FILE | No | 包含 JDBC URL 格式的文件的路径。 可以代替 NC_DB 使用。 用于一键式 Heroku 部署| | -| NC_PUBLIC_URL | Yes | 用于发送电子邮件邀请 | 尽量从 http 请求参数推测一个 | -| NC_AUTH_JWT_SECRET | Yes | JWT secret 用于认证和存储其他加密项 | 将会产生一个随机的 secret | -| NC_SENTRY_DSN | No | 用于 Sentry 监控 | | -| NC_CONNECT_TO_EXTERNAL_DB_DISABLED | No | 禁止使用外部数据库创建项目 | | -| NC_DISABLE_TELE | No | 禁用 telemetry | | -| NC_BACKEND_URL | No | 自定义后端URL | 将使用`http://localhost:8080` | - -# 开发安装 - -```bash -git clone https://github.com/nocodb/nocodb -cd nocodb - -# 运行后端 -cd packages/nocodb -npm install -npm run watch:run - -# 在浏览器打开 localhost:8080/dashboard - -# 运行前端 -cd packages/nc-gui -npm install -npm run dev - -# 在浏览器打开 localhost:3000/dashboard -``` - -对代码做更改后会自动重新启动服务。 - -## 在本地运行 Cypress 测试 -```bash -# 安装开发依赖(cypress) -npm install - -# 使用 docker compose 使用所需的数据库运行 mysql 数据库 -docker-compose -f ./scripts/docker-compose-cypress.yml up - -# 使用以下命令运行后端 api -npm run start:api +Please refer to [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables) -# 使用以下命令运行前端 Web UI -npm run start:web - -# 等到 3000 和 8080 端口都可用时，使用以下命令运行Cypress测试 -npm run cypress:run - -# or run following command to run it with GUI -npm run cypress:open +# 开发安装 -``` +Please refer to [Development Setup](https://github.com/nocodb/nocodb/tree/master#development-setup) # 贡献 -- 请看一下 ./scripts/contribute/HowToApplyLicense.md -- 忽略为 .json 或 .md 或 .yml 添加标头 +Please refer to [Contribution Guide](https://github.com/nocodb/nocodb/blob/master/.github/CONTRIBUTING.md). -# 🎯 为什么我们建立这个？ +# 为什么我们建立这个？ 大多数互联网业务都配备了电子表格或数据库以解决其业务需求，每天有上亿人使用电子表格。我们基于数据库运行更强大的工具能更高效地完成工作。用SaaS产品解决此问题的尝试已经意味着可怕的访问控制，供应商锁定，数据锁定，突然的价格变化，甚至是将来可能会阻碍发展。 -# ❤ 我们的任务 ： +# 我们的任务 我们的使命是为数据库提供最强大的无码界面，为世界上每一个互联网业务的开源使用。这不仅将民主化带给强大的计算工具，还将为数亿人增强他们的创造力。