开源项目 Platforms Starter Kit 使用教程

开源项目 Platforms Starter Kit 使用教程

platform-starter-kit Cal.com Platform: Starter Kit 项目地址: https://gitcode.com/gh_mirrors/pl/platform-starter-kit

1. 项目介绍

Platforms Starter Kit 是一个用于构建多租户应用程序的完整堆栈模板，支持自定义域名。该项目基于 Next.js App Router、Vercel Postgres 和 Vercel Domains API 构建。它提供了一系列功能，包括无限域名/SSL 证书的程序化分配、按需缓存失效、AI 驱动的 Markdown 编辑器、自定义字体、404 页面、favicon、站点地图等。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保你已经安装了以下工具：

• Node.js (建议版本 14.x 或更高)
• npm 或 yarn
• Git

2.2 克隆项目

首先，克隆项目到本地：

git clone https://github.com/calcom/platform-starter-kit.git
cd platform-starter-kit

2.3 安装依赖

使用 npm 或 yarn 安装项目依赖：

npm install
# 或者
yarn install

2.4 配置环境变量

在项目根目录下创建一个 .env.local 文件，并添加以下环境变量：

NEXT_PUBLIC_VERCEL_ENV=development
NEXT_PUBLIC_VERCEL_URL=http://localhost:3000

2.5 启动开发服务器

运行以下命令启动开发服务器：

npm run dev
# 或者
yarn dev

现在，你可以在浏览器中访问 http://localhost:3000 查看项目。

3. 应用案例和最佳实践

3.1 应用案例

Platforms Starter Kit 已经被多个平台用于构建多租户应用程序，例如：

• Hashnode：一个开发者博客平台，支持自定义域名。
• Super.so：一个静态站点生成器，支持自定义域名和 AI 驱动的 Markdown 编辑器。
• Incident.io：一个事件管理平台，支持自定义域名和动态 OG 图像生成。

3.2 最佳实践

• 自定义域名管理：使用 Vercel Domains API 管理自定义域名，确保每个租户都有独立的域名。
• 缓存失效：利用 revalidateTag 实现按需缓存失效，提高应用的性能和用户体验。
• AI 驱动的编辑器：集成 AI 驱动的 Markdown 编辑器，提升内容创作的效率。

4. 典型生态项目

Platforms Starter Kit 依赖于多个开源项目和工具，以下是一些典型的生态项目：

• Next.js：一个用于构建 React 应用的框架，支持服务器端渲染和静态站点生成。
• Vercel Postgres：一个无服务器的关系型数据库，适用于多租户应用。
• Vercel Domains API：一个用于管理自定义域名的 API，支持 SSL 证书的自动配置。
• Novel：一个 AI 驱动的 Markdown 编辑器，支持实时预览和语法高亮。

通过这些生态项目的集成，Platforms Starter Kit 提供了一个完整的解决方案，帮助开发者快速构建和部署多租户应用程序。

platform-starter-kit Cal.com Platform: Starter Kit 项目地址: https://gitcode.com/gh_mirrors/pl/platform-starter-kit