Skip to content

🚀 快速开始

本指南将帮助你快速搭建 Dream Hub,包括环境准备、安装依赖、本地运行以及部署。

📌 1. 环境准备

在开始之前,请确保你已安装以下工具:

  • Node.js(建议使用版本 20.0以上)
  • pnpm(用于管理 monorepo 依赖)
  • Mise or Nvm(推荐用于管理 Node.js 版本)

🛠️ 2. 安装依赖

sh
# 克隆仓库
git clone https://github.com/myltx/dream-hub.git
cd dream-hub

# 使用 pnpm 安装依赖
pnpm install

💡 说明

Dream Hub 采用 pnpm workspace 进行项目管理,client 目录用于前端,api 目录用于后端。

🛠️ 3. 配置环境变量

3.1 前端(Nuxt3):在 client/.env 文件中配置以下变量:

sh
# Supabase 后端 API 地址
# logto 配置
NUXT_LOGTO_ENDPOINT=
NUXT_LOGTO_APP_ID=
# NUXT_LOGTO_ENDPOINT=
# NUXT_LOGTO_APP_ID=
BACKEND_ENDPOINT=

LOGTO_SIGN_IN_REDIRECT_URI =
LOGTO_SIGN_OUT_REDIRECT_URI =

# supabase 配置
SUPABASE_URL=
SUPABASE_KEY=


# API_BASE=
API_BASE=

# project config
PROJECT_NAME= Dream-hub

# AI
AI_API_KEY=
AI_BASE_URL=

3.2 后端(NestJS):在 api/.env 文件中配置以下变量:

sh
# supabase 配置
SUPABASE_URL=
SUPABASE_KEY=
SUPABASE_JWT_SECRET=

# redis 配置
REDIS_URL=

# server 配置
PORT=8081

# logto 配置
LOGTO_ENDPOINT=
LOGTO_APP_ID=
# LOGTO_ENDPOINT=
# LOGTO_APP_ID=
BACKEND_ENDPOINT=
LOGTO_CLIENT_ID=
LOGTO_CLIENT_SECRET=

<!-- # AI -->

## 🔥 4. 本地运行

### 4.1 启动后端(NestJS)

```sh
pnpm dev:server

4.2 启动前端(Nuxt3)

sh
pnpm dev:client

📌 注意

确保前端的 .env 配置正确,指向你的 Supabase 后端 API 地址,以及 logto 配置。

🎯 6. 目录结构

markdown
dream-hub/
├── apps/
│ ├── api/ # 后端 (NestJS)
│ ├── client/ # 前端 (Nuxt3)
├── packages/
│ ├── supabase/ # Supabase 相关工具
│ ├── docs/ # VitePress 文档
└── pnpm-workspace.yaml

🎉 7. 你已成功启动 Dream Hub!

现在你可以开始使用 Dream Hub 进行网站管理,并体验 AI 推荐、智能分类 等功能了!🚀

接下来,你可以根据需要进一步自定义和扩展 Dream Hub 的功能。

🚀 8. Vecel 部署指南

8.1 Vercel 一键部署

  • Fork 本项目,在 Vercel 官网点击 New Project

  • 点击 Import Git Repository 并选择你 fork 的此项目并点击 import

  • PROJECT NAME自己填,FRAMEWORK PRESETOther 然后直接点 Deploy 接着等部署完成即可

Deploy with Vercel

8.2 Vecel 本地部署

powershell
// 全局安装 vercel
npm i -g vercel

// 登录
vercel login

// 项目推送
vercel

// 挂载生产
vercel --prod

具体教程可参考文章:如何使用 Vercel 托管静态网站


📌 了解更多

Released under the MIT License.