MkSaaS文档入门文档
学习如何在几分钟内设置和运行您的目录网站
本文档将引导您完成 MkSaaS 的设置。我们将介绍克隆项目、安装依赖项、设置数据库和运行本地开发服务器的过程。
前提条件
在开始之前，请确保您已安装以下软件：
Node.js
Node.js 是一个允许您运行 JavaScript 代码的运行时环境。
如果您没有安装 Node.js，请从 Node.js 官方网站 下载。
# 检查是否安装了 Node.js
node --version快速安装
设置您的项目
您有多种方式可以下载 MkSaaS 的源代码，我们将介绍一些最常见的方式，您可以选择最适合您的方式。
我们建议从 Fork GitHub 仓库开始。
当您访问 GitHub 仓库 时，您会在右上角看到一个"Fork"按钮。点击它将在您的 GitHub 账户中创建 MkSaaS 仓库的副本，请保持此仓库为私有。
一旦您 fork 了仓库，您就可以将您的 fork 克隆到电脑本地：
git clone https://github.com/your-username/mksaas-template.git your-project-name
cd your-project-name您也可以直接从 GitHub 克隆仓库。
git clone https://github.com/MkSaaSHQ/mksaas-template.git your-project-name
cd your-project-name
git remote remove origin如果您愿意，可以从 GitHub 下载源代码的 ZIP 文件。
访问仓库页面，点击 Code 按钮，然后点击 Download ZIP。
下载后，将 ZIP 文件解压到您想要的位置，并在终端中导航到解压的目录。
关于 fork 仓库
- 完整历史记录： 您保留项目的完整提交历史记录。
- 轻松更新： 您可以使用拉取请求轻松从原始仓库拉取更新。
- 支持贡献： 如果您想要贡献您的代码到模板库，您的 fork 已经为此设置好了。
- 只有一个 Fork： 您只能有一个仓库的 fork，但您可以多次克隆仓库，因此您可以基于模板构建多个网站。
如果您希望能够从 MkSaaS 模板仓库拉取更新，您可以添加上游远程，这将允许从 MkSaaS 仓库进行更简单的更新过程。
git remote add upstream https://github.com/MkSaaSHQ/mksaas-template.git设置环境变量
MkSaaS 使用环境变量来配置项目。您可以在 .env 文件中设置它们，因此首先将 env.example 文件复制到 .env 作为起点。
cp env.example .env然后，打开 .env 文件并将变量设置为您想要的值。您可以在环境配置文档中找到有关环境变量的更多信息。
启动开发服务器
现在您已经设置好数据库，可以通过运行以下命令启动开发服务器：
pnpm run devnpm run devyarn devbun run dev这将在 http://localhost:3000 上访问模板网站。
视频教程
下一步
现在您已经运行了 MkSaaS，以下是一些后续步骤：