Skip to content

tlyboy/home

Repository files navigation

home

🖖 Guany 的首页

✨ 特性

  • 📦 基于 Nuxt 3 构建,享受现代化开发体验
  • 🎨 集成 TailwindCSS,快速构建美观界面
  • 🌓 内置深色/浅色主题切换功能
  • 📱 针对各种设备的响应式设计
  • 🚀 支持一键部署到 Netlify/Vercel/Docker
  • 🔧 完整的开发文档和部署指南

🛠️ 技术栈

  • Nuxt 3 - 强大的 Vue 全栈框架
  • Vue 3 - 渐进式 JavaScript 框架
  • TailwindCSS - 实用优先的 CSS 框架
  • TypeScript - 类型安全的 JavaScript 超集

📦 开始使用

环境准备

依赖项 要求 说明
Node.js 24.x 推荐使用 fnm 或其他 Node.js 版本管理器
corepack enable 启用 corepack 功能,使用 corepack enable 命令

本地开发

  1. 克隆项目并安装依赖
git clone https://github.com/tlyboy/home.git
cd home
pnpm install
  1. 配置环境变量

创建 .env 文件并配置以下环境变量:

# GitHub Token(必需)
NUXT_GITHUB_TOKEN=your_github_token

# 备案信息配置(可选)
NUXT_PUBLIC_ICP_NUMBER=your_icp_number
NUXT_PUBLIC_ICP_LINK=https://beian.miit.gov.cn/
NUXT_PUBLIC_POLICE_NUMBER=your_police_number
NUXT_PUBLIC_POLICE_LINK=your_police_link

注意:备案信息为可选配置。如果配置了备案信息,页面底部将显示备案链接;如果未配置,则显示 MIT 许可和版权信息。

  1. 启动开发服务器
pnpm run dev

访问 http://localhost:3000 开始开发

🚀 部署指南

Netlify 部署

  1. 点击顶部 "Deploy to Netlify" 按钮
  2. 登录或注册 Netlify 账号
  3. 环境变量配置:
环境变量 必需 说明
NUXT_GITHUB_TOKEN GitHub 访问令牌 用于 API 访问
NUXT_PUBLIC_ICP_NUMBER ICP 备案号 ICP 备案信息
NUXT_PUBLIC_ICP_LINK ICP 备案链接 ICP 备案跳转地址
NUXT_PUBLIC_POLICE_NUMBER 公安备案号 公安备案信息
NUXT_PUBLIC_POLICE_LINK 公安备案链接 公安备案跳转地址

Vercel 部署

  1. 点击顶部 "Deploy with Vercel" 按钮
  2. 登录或注册 Vercel 账号
  3. 环境变量配置:
环境变量 必需 说明
ENABLE_EXPERIMENTAL_COREPACK 1 启用 corepack
NUXT_GITHUB_TOKEN GitHub 访问令牌 用于 API 访问
NUXT_PUBLIC_ICP_NUMBER ICP 备案号 ICP 备案信息
NUXT_PUBLIC_ICP_LINK ICP 备案链接 ICP 备案跳转地址
NUXT_PUBLIC_POLICE_NUMBER 公安备案号 公安备案信息
NUXT_PUBLIC_POLICE_LINK 公安备案链接 公安备案跳转地址

Docker 部署

  1. 克隆项目
git clone https://github.com/tlyboy/home.git
cd home
  1. 配置环境变量

创建 .env 文件并配置以下环境变量:

# GitHub Token(必需)
NUXT_GITHUB_TOKEN=your_github_token

# 备案信息配置(可选)
NUXT_PUBLIC_ICP_NUMBER=your_icp_number
NUXT_PUBLIC_ICP_LINK=https://beian.miit.gov.cn/
NUXT_PUBLIC_POLICE_NUMBER=your_police_number
NUXT_PUBLIC_POLICE_LINK=your_police_link
  1. 启动服务
docker compose up -d

访问 http://localhost:3000 即可查看网站。

📄 开源协议

本项目采用 MIT 协议 开源,欢迎 Star 和贡献!

🤝 贡献指南

  1. Fork 本仓库
  2. 创建特性分支
  3. 提交改动
  4. 发起 Pull Request

📮 问题反馈

如有问题或建议,欢迎提交 Issue

About

🖖 Guany 的首页

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published