Teable 开源项目教程

Teable 开源项目教程

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

1. 项目目录结构及介绍

Teable 的目录结构如下，展示了该项目的主要组成部分：

.
├── apps                # 应用程序代码目录
│   ├── nestjs-backend  # 后端服务代码
│   └── nextjs-app      # 前端应用代码
├── env                 # 环境变量模板
├── scripts              # 脚本工具
└── ...

• apps: 包含项目的前端和后端代码。
  • nestjs-backend: 使用 NestJS 框架编写的后端服务，处理数据操作和API请求。
  • nextjs-app: 基于 Next.js 构建的前端应用程序，提供用户界面。

2. 项目的启动文件介绍

• 后端启动文件:

  • 在 apps/nestjs-backend 目录下，运行 pnpm dev 来启动开发服务器。该命令将监视文件变更并自动重启服务。

• 前端启动文件:

  • 当后端服务器启动时，前端Next.js应用会自动加载并热重载。无需单独启动前端服务器。

3. 项目的配置文件介绍

• 环境变量:
  • 项目使用环境变量进行配置。在 env 文件夹中，有 development, production 和 local 等模板文件。
  • 若要设置本地开发环境的变量，可以复制 env/development 并命名为 env.development.local，然后编辑以适应本地需求。
  • 变量可以通过运行特定命令（如 make switch-db-mode）来切换或更新。

请注意，具体的配置项可能需要根据项目中的 .env.example 或者其他相关文档进一步理解其用途和值。对于更详细的配置指南，建议查看项目文档或阅读源码注释。

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