快速开始

LaunchSaaS 快速入门指南 – 克隆仓库、安装依赖、配置数据库，几分钟内在本地运行你的 SaaS 项目。

本指南将引导你完成 LaunchSaaS 的设置。我们将介绍克隆项目、安装依赖、设置数据库和运行本地开发服务器的过程。

前置条件

在开始之前，请确保已安装以下内容：

Node.js

需要 Node.js 20+。如果未安装 Node.js，请从 Node.js 官网下载。

# 检查是否已安装 Node.js
node --version

Git

Git 是用于跟踪文件更改的版本控制系统。如果未安装 Git，请从 Git 官网下载。

# 检查是否已安装 Git
git --version

包管理器

我们推荐使用 pnpm，但你也可以使用 npm、yarn 或 bun。

快速安装

1. 设置你的项目

将仓库克隆到本地机器：

git clone https://github.com/LaunchSaasOrg/saas.git your-project-name
cd your-project-name

仓库中的 apps/launchsaas/ 是真实的 LaunchSaaS 产品 App。将它复制到你自己的应用目录，在其中进行所有自定义：

cp -r apps/launchsaas apps/your-app

然后将 apps/your-app/package.json 中的 name 字段改为你的应用名称：

// apps/your-app/package.json
{ "name": "your-app" }

最后，更新根目录的 package.json，将所有 --filter launchsaas 替换为 --filter your-app，使工作区脚本指向你的应用：

// package.json（根目录）
{
  "scripts": {
    "dev": "pnpm --filter your-app dev",
    "build": "pnpm --filter your-app build",
    "start": "pnpm --filter your-app start",
    "db:generate": "pnpm --filter your-app db:generate",
    "db:migrate": "pnpm --filter your-app db:migrate",
    "db:push": "pnpm --filter your-app db:push",
    "init:db": "pnpm --filter your-app init:db",
    "init:scripts": "pnpm --filter your-app init:scripts"
  }
}

apps/launchsaas/ 作为参照保留并接收上游更新。在你自己的副本（如 apps/your-app/）中进行所有定制，以便后续合并 LaunchSaaS 更新时不产生冲突。

2. 安装依赖

运行以下命令安装依赖：

pnpm install

3. 设置环境变量

将示例环境文件复制到你的应用目录：

cp apps/your-app/.env.example apps/your-app/.env

然后打开 apps/your-app/.env 并填写所需的值。.env.example 文件包含所有可用变量及内联注释说明。

4. 初始化数据库

运行数据库初始化命令：

pnpm run init

此命令将：

生成数据库迁移
将迁移应用到你的数据库
创建管理员用户

运行此命令前，请确保已在 apps/your-app/.env 中配置了 DATABASE_URL。请参阅数据库指南了解设置说明。

5. 启动开发服务器

pnpm run dev

这将在 http://localhost:3000 上启动开发服务器。

验证安装

要验证一切是否正常工作：

主页：访问 http://localhost:3000 - 你应该看到着陆页
登录：前往 http://localhost:3000/auth/sign-in - 尝试使用管理员凭据登录（来自你的 .env 文件）
仪表板：登录后，你应该被重定向到仪表板
管理面板：访问 http://localhost:3000/en/admin 访问管理功能（注意 /en locale 前缀）

开发命令

命令	描述
`pnpm run dev`	启动开发服务器
`pnpm run build`	构建生产版本
`pnpm start`	启动生产服务器
`pnpm run format`	使用 Biome 检查、格式化并自动修复
`pnpm run db:generate`	生成数据库迁移
`pnpm run db:migrate`	应用数据库迁移
`pnpm run init`	初始化数据库并创建管理员

下一步

现在你已经运行了 LaunchSaaS，以下是一些后续步骤：

数据库

配置你的数据库

身份验证

配置身份验证提供商

支付

设置支付集成

Provider 配置

选择邮件、缓存、存储等 Provider

数据库

身份验证

支付

Provider 配置

On this page