IndieShow 图标IndieShow 使用文档

快速开始

从环境准备到项目启动,快速搭建 IndieShow 项目,包括获取代码、安装依赖、配置环境变量和一键部署指南

本指南将帮助您在几分钟内设置并运行 IndieShow-Starter-Nuxt 项目。

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

  • Node.js ≥ 18.0
  • pnpm ≥ 8.0
  • Git

您可以使用以下命令检查它们是否已正确安装:

# 检查 Node.js 版本
node -v
 
# 检查 pnpm 版本
pnpm -v
 
# 检查 Git 版本
git --version

如果需要安装这些工具,请参考环境准备指南。

有三种方式获取项目代码:

使用 GitHub 模板的优势

  • 完整历史:保留项目的所有提交记录,方便追踪项目修改记录
  • 轻松更新:可以通过拉取请求(Pull Request)轻松获取原仓库的最新更新
  • 便于贡献:如果您想参与项目贡献,可以随时提交

我们推荐您通过 GitHub 模板。

当您访问 GitHub 仓库时,您会在右上角看到一个"Use this template"按钮。点击它将会在您的 GitHub 账户中创建一个 IndieShow 仓库的副本。

一旦您完成了仓库的创建,您可以将其克隆到本地计算机:

  1. 访问 IndieShow-Starter-Nuxt 仓库
  2. 点击右上角的 使用此模板 按钮
  3. 填写您的仓库名称并创建新仓库
  4. 将您的新仓库克隆到本地:
git clone https://github.com/您的用户名/您的仓库名.git
cd 您的仓库名

进入项目目录后,使用 pnpm 安装依赖:

pnpm install

项目使用环境变量来管理配置。复制示例环境文件并根据需要修改:

cp .env.example .env

打开 .env 文件,根据您的需求修改配置(主要包括网站名称、URL和分析ID等)。关键配置项包括:

# 站点基本配置
NUXT_PUBLIC_SITE_NAME=您的网站名称
NUXT_PUBLIC_SITE_URL=https://您的域名.com
 
# Google Analytics 配置(可选)
NUXT_PUBLIC_GA_ID=G-XXXXXXXXXX
......
......

更多环境变量配置说明,请参考参数配置文档。

启动开发服务器:

pnpm dev

此命令会启动开发服务器,通常在 http://localhost:3000 可访问。开发服务器支持热重载,当您修改代码时,浏览器会自动刷新。

准备部署到生产环境时,运行以下命令构建优化后的版本:

pnpm build

构建完成后,您可以使用以下命令预览生产构建:

pnpm preview

IndieShow-Starter-Nuxt 支持在多个平台上一键部署:

点击下方按钮,按照提示完成部署配置。Vercel 会自动检测 Nuxt.js 项目并应用最佳配置。 Deploy with Vercel

常见问题

下一步

目录