Teable 安装与配置完全指南

Teable 安装与配置完全指南

teable 项目地址: https://gitcode.com/gh_mirrors/te/teable

项目基础介绍及编程语言

Teable 是下一代无代码数据库平台，被设计成 Airtable 的强大替代品。它结合了超高速度、实时性、专业性和对开发者的友好性，使用类似于电子表格的直观接口，在PostgreSQL数据库之上构建。此项目主要采用 TypeScript 作为主要开发语言，并融入了 JavaScript、ANTLR、Makefile、Handlebars 和 Shell 等多种技术元素，确保高度灵活性与高效性。

关键技术和框架

• PostgreSQL: 底层数据库系统，提供了强大的数据存储与处理能力。
• React: 在前端部分用于构建用户界面，特别是UI库部分。
• NestJS: 后端服务的框架，基于Node.js，用于构建高效且可扩展的服务端逻辑。
• Prisma: ORM工具，简化了与PostgreSQL的交互。
• Full-Featured SQL Support: 支持直接的SQL查询，便于数据工程师和开发者集成。
• Real-time Collaboration: 利用WebSocket或其他技术实现的数据实时同步。

安装和配置详细步骤

准备工作

1. 确保环境: 首先，你需要安装Git，Node.js(v14及以上)，以及PNPM或Yarn/NPM包管理器。
2. 数据库准备: Teable支持SQLite和PostgreSQL。对于初学者，SQLite是个不错的选择因为不需要额外服务器配置。

步骤一：克隆项目

打开终端，运行以下命令来克隆Teable项目:

git clone https://github.com/teableio/teable.git
cd teable

步骤二：安装依赖

接下来，初始化并安装项目所需的依赖项：

corepack enable  # 确保核心包管理器已启用
pnpm install     # 使用PNPM安装所有必要的依赖

如果你没有corepack，可以通过npm install -g corepack来安装。

步骤三：选择数据库模式（可选）

如果你想切换数据库模式（比如从SQLite到PostgreSQL），在项目根目录下使用make命令：

make switch-db-mode

按照提示进行相应的配置更改。

步骤四：配置环境变量

• 对于开发环境，你可以复制示例环境文件：

  cp .env.development.example .env.development
  

  根据你的需要调整.env.development中的数据库连接字符串和其他配置。

步骤五：启动开发服务器

首先，确保已经选择了正确的数据库模式并配置好环境变量。然后，启动后端服务，它会自动启动前端服务器：

cd apps/nestjs-backend
pnpm dev

此时，前端应用应该能够自动加载，你也可以单独启动前端进行更细致的调试，但通常上述步骤足够开始开发流程。

注意事项

• 实际部署时，你需要考虑更复杂的配置，包括生产环境的环境变量设置、数据库的正式部署、SSL证书、服务器配置等。
• 确保遵循Teable官方文档中提供的指南，尤其是关于部署、权限管理和安全性方面的细节。

通过以上步骤，即使是新手也应该能顺利地开始使用Teable进行开发和探索。记得查阅项目仓库的最新文档，因为依赖和步骤可能会随项目更新而变化。

teable 项目地址: https://gitcode.com/gh_mirrors/te/teable