Vercel-Flare ✨

• English translation: README_en.md

感谢项目 https://github.com/soulteary/docker-flare 提供的外观灵感与数据结构。本仓库为纯静态、只读的导航页，适配 Vercel/任意静态托管，不包含在线编辑或后台。

Demo

• 在线演示: https://vercel-flare-demo.vercel.app

特性

• 数据全部来自 app/*.yml，构建时读入后导出静态站点
• 无后端依赖、无运行时写操作，默认内置所需 SVG 图标(按需在构建阶段拉取)
• 移动端两列布局自适应，空分类自动隐藏
• 已将 Next.js 升级至 >=16.0.7（修复 CVE-2025-66478）

目录约定

• app/*.yml：项目配置
• frontend/public/icons：构建时按需拉取的 SVG 图标，请避免人为增删

快速开始

1. 部署前，请先修改./app内的项目配置文件
   • 如果使用 Vercel 部署，这一步应该在部署结束后在自己的仓库进行
2. 参照下文部署方式部署
3. 愉快使用😉

如何个性化icon？

前往 https://pictogrammers.com/library/mdi/ 挑选你喜欢的icon，将其名称填至配置文件对应位置，部署时会自动拉取所需的图标

Vercel 部署（推荐）

自动部署：

手动部署：

1. 使用模板创建自己的项目(推荐选用private)
2. 准备配置（修改项目默认配置文件）
   • apps.yml：links 列表，name/link 必填，可选 icon、desc
   • bookmarks.yml：categories（id、title），links（name、link，可选 icon、category）
   • config.yml：站点标题、描述、是否显示时钟、是否新开标签、页脚开关与文案
3. 在Vercel选择自己的项目（项目已配置构建流程，无需额外配置，直接选择构建即可），开始构建

仓库根目录 vercel.json 已配置默认流程：

buildCommand: "cd frontend && npm install && npm run build"
outputDirectory: "frontend/out"

推送后自动重新构建；如需自定义环境变量或域名，请在 Vercel 控制台配置。

本地部署

1. 安装依赖

   cd frontend
   npm install

2. 准备配置（修改项目默认配置文件）
   • apps.yml：links 列表，name/link 必填，可选 icon、desc
   • bookmarks.yml：categories（id、title），links（name、link，可选 icon、category）
   • config.yml：站点标题、描述、是否显示时钟、是否新开标签、页脚开关与文案
3. 本地开发

   cd frontend
   npm run dev   # http://localhost:3000，实时读取 ../app 下 YAML

4. 生产构建与静态预览

   cd frontend
   npm run lint
   npm run build    # 自动按需下载 YAML 中引用的图标到 frontend/public/icons
   npm run start    # serve frontend/out，默认 5005 端口

   frontend/out 可直接上传到任意静态空间。

授权

本项目基于 MIT License 发布，详见 LICENSE