TanStarter Docs

快速开始

学习如何在几分钟内设置和运行您的 TanStarter 网站

本文档将引导您完成 TanStarter 的设置。

前提条件

在开始之前,请确保您已安装以下软件:

Git

Git 是一个版本控制系统,用于跟踪任何文件的更改。

如果未安装 Git,请从 Git 官方网站 下载。

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

Node.js

Node.js 是一个允许您运行 JavaScript 代码的运行时环境。

如果未安装 Node.js,请从 Node.js 官方网站 下载。

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

PNPM

包管理器是用于管理项目中依赖项的工具,我们推荐使用 pnpm

# 如果您还没有安装 pnpm,请安装它
npm install -g pnpm

# 其他平台可以通过其他方式安装:https://pnpm.io/installation

# 检查 pnpm 版本
pnpm --version

GitHub CLI

GitHub CLI(gh)用于将密钥同步到 GitHub,以便通过 GitHub Actions 实现自动化部署。安装并登录:

# 安装 gh(macOS)
brew install gh

# 其他平台可以通过其他方式安装:https://github.com/cli/cli#installation

# 检查是否安装了 gh
gh --version

# 登录到 GitHub
gh auth login

# 检查账号状态
gh auth status

快速配置

新建您的项目

从 GitHub 克隆模板项目仓库:

git clone https://github.com/MkFastHQ/mkfast-template.git your-project-name

cd your-project-name

移除原始远程模板项目仓库连接,并创建一个私有的 GitHub 项目仓库。

# 移除原始远程模板项目仓库
git remote remove origin

# 在 GitHub 上创建一个私有仓库,并设置为远程仓库
gh repo create your-project-name --private --source=. --remote=origin

# 推送代码到您的新项目仓库,并设置默认分支为 main
git push -u origin main

此命令会创建一个私有 GitHub 仓库、将其设置为 origin 远程仓库,并推送代码。

安装项目依赖

通过运行以下命令安装项目依赖:

pnpm install

设置环境变量

.env.example 文件复制到 .env 作为起点。

cp .env.example .env

打开环境变量文件并将变量设置为您想要的值,您可以在环境配置文档中找到有关环境变量的更多信息。

启动开发服务器

现在您已经设置好环境变量,可以通过运行以下命令启动开发服务器:

pnpm run dev

这将在 http://localhost:3000 上启动开发服务器,您可以访问模板网站。

视频教程

下一步

现在您已经运行了 TanStarter,以下是一些后续步骤:

最后更新于

本页目录