Skip to content

wtfllix/navidash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧭 NaviDash

一个极简、高效、高度可定制的个人导航仪表盘。 A clean, efficient, and highly customizable personal dashboard.

中文 | English

License Version Next.js TypeScript Docker

NaviDash 专为追求极致效率与美学的用户设计。它摒弃了繁杂的装饰,以经典的“洞洞板”风格为基础,结合自由拖拽的网格布局,为您打造一个既美观又实用的浏览器起始页。


🌟 核心功能

  • 🎨 高度可定制 UI

    • 自由布局:基于 Grid 的拖拽式看板,随心所欲调整组件位置与大小。
    • 背景系统:默认洞洞板 (Pegboard) 风格,支持 HTTP 图片链接作为壁纸。
    • 视觉微调:内置背景模糊与遮罩透明度调节,确保任何壁纸下内容都清晰易读。
  • 🧩 实用小组件

    • 时钟:支持数字/拟真双模式切换。
    • 天气:实时天气更新 (QWeather 驱动)。
    • 效率工具:待办事项 (Todo)、便签 (Memo)、日历 (Calendar)。
    • 相框:展示你喜爱的照片。
  • 📑 强大的书签管理

    • 无限层级:侧边栏支持书签文件夹无限嵌套。
    • 智能图标:自动集成 Lucide 图标库。
    • 拖拽整理:直观的拖拽排序体验。
  • 💾 数据安全与自托管

    • 完全掌控:所有数据均可导出为 JSON 备份,随时恢复。
    • Docker 部署:提供开箱即用的 Docker 镜像,数据存储在本地 JSON 文件中,支持多端实时同步。

🚀 快速开始

🐳 使用 Docker 部署(推荐)

这是最简单的运行方式,无需配置本地 Node.js 环境。

  1. 克隆仓库

    git clone https://github.com/wtfllix/navidash.git
    cd navidash
  2. 准备数据目录(推荐放在仓库外)

    sudo mkdir -p /opt/navidash-data

    docker-compose.yml 默认会把数据挂载到 /opt/navidash-data。不建议继续使用仓库内的 ./data 目录,否则在重新部署、替换仓库目录或误删工作区时更容易丢失数据。

    如果你想自定义数据目录,也可以在启动前指定环境变量:

    export NAVIDASH_DATA_DIR=/your/data/path
  3. 启动容器

    docker-compose up -d
  4. 访问应用 打开浏览器访问 http://localhost:3000 即可开始使用。

🔄 更新指南 (Upgrade)

如果您正在使用 Docker 部署,可以通过以下命令轻松升级到最新版本:

  1. 拉取最新代码 (如果你使用了 docker-compose.yml)

    git pull
  2. 拉取最新镜像

    docker-compose pull
  3. 重启容器

    docker-compose up -d

    只要你将数据目录挂载到仓库外位置(默认 /opt/navidash-data),升级过程不会删除你的数据。

  4. 如果你之前把数据放在仓库内的 ./data 可以先停掉容器,再迁移数据:

    docker-compose down
    sudo mkdir -p /opt/navidash-data
    sudo cp -a ./data/. /opt/navidash-data/
    docker-compose up -d

🛠️ 本地开发

如果您想参与开发或进行二次修改:

  1. 环境准备

    • Node.js 18+
    • npm / yarn / pnpm
  2. 安装依赖

    npm install
  3. 启动开发服务器

    npm run dev

    访问 http://localhost:3000

  4. 构建生产版本

    npm run build
    npm start

📖 用户指南

详细的使用说明请参考 用户指南 (User Guide)

🤝 贡献

欢迎提交 Issue 和 Pull Request!

📄 许可证

MIT License


📝 更新日志 (Changelog)

v0.4.0

  • 🧩 组件商店拖拽升级:支持从组件商店拖拽到主面板后自动收起侧栏,并将焦点切回主面板。
  • 📍 放置体验优化:拖拽时提供占位反馈,放置后按目标位置落位,不再出现“回弹飞回”效果。
  • 🔁 冲突避让增强:新增链式下移重排,冲突组件按顺序下移,减少跨列跳跃与尾部飞移。
  • 编辑模式一致性:编辑模式拖动与组件商店拖拽统一冲突检测与预排版反馈,交互更稳定。
  • 🧪 回归测试补充:新增组件放置与冲突场景测试(含长条组件与异高组件场景)。

v0.3.2

  • 🔗 新增 Links Widget: 新增链接集合小组件,支持分组标题、图标大小调整、标签显示开关,以及批量导入功能
  • 🧠 智能布局: 改进 WidgetPicker 添加组件时的智能占位检测算法,避免组件重叠
  • 🖱️ 交互优化: 增强拖拽手柄样式,提升视觉反馈和操作体验
  • 🔧 类型安全: 更新 Zod schema 验证,支持 links 类型组件
  • 🧪 测试覆盖: 添加 links widget 的 schema 验证测试

v0.3.1

  • 🐛 Bug Fixes: 修复了快捷链接 (Quick Link) 和备忘录 (Memo) 组件在部分情况下无法同步配置的问题。
  • Feature: 快捷链接组件现在支持自动获取网站图标 (Favicon)。
  • 🐳 Docker: 优化了 docker-compose.yml 配置,默认使用 GHCR 镜像。

v0.3.0

  • 🔄 全方位多端同步:支持书签、小组件布局、个性化设置在多设备间实时同步。
  • 🚀 智能性能优化:引入页面可见性检测,页面后台运行时自动暂停同步。
  • 🐳 Docker 部署升级:新增 entrypoint 脚本自动修复权限,解决 EACCES 问题。

v0.2.1

  • 📏 布局升级:优化网格响应式断点,提升空间利用率。
  • ☀️ 天气优化:重设计 1x2/1x3 布局,解决文字截断。
  • 🧩 组件增强:新增组件分类系统,优化选择器 UI。
  • 🌍 国际化:补充缺失翻译。

v0.2.0

  • 🕰️ 拟真时钟:新增无边框拟真时钟。
  • 🎨 背景管理:支持自定义图片 + 模糊调节。
  • ⚙️ 配置简化:移除冗余预设,优化交互。

Star History

Star History Chart

About

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages