快速开始

本指南将引导你完成 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

2. 安装依赖

运行以下命令安装依赖：

pnpm install

3. 设置环境变量

复制示例环境文件作为起点：

cp .env.example .env

然后，打开 .env 文件并将变量设置为所需的值。你可以在环境配置指南中找到更多信息。

4. 初始化数据库

运行数据库初始化命令：

pnpm run init

此命令将：

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

5. 启动开发服务器

pnpm run dev

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

验证安装

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

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

开发命令

下一步

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