现代化导航管理平台 | Modern Navigation Management Platform

GitHub stars GitHub forks GitHub issues GitHub license

Deploy with Vercel

NavSphere 是一个基于 Next.js 14 构建的现代化导航管理平台,专为个人和团队打造的书签管理和导航门户解决方案。通过 GitHub 作为数据存储后端,提供安全、可靠的导航数据管理体验。[手把手快速部署教程]

NavSphere Logo

NavSphere Logo

• 🚀 现代技术栈: Next.js 14 + React 18 + TypeScript + Tailwind CSS
• 🔐 GitHub 认证: 基于 NextAuth.js 的 GitHub OAuth 安全登录
• 📊 Git 数据存储: 使用 GitHub 仓库作为数据后端,版本可控
• 📱 响应式设计: 移动优先的设计理念,完美适配各种设备
• 🌓 主题切换: 内置深色/浅色主题支持
• 🎯 拖拽排序: 直观的拖拽界面,轻松管理导航项目
• 🔍 智能搜索: 快速定位和访问导航项目
• 📱 PWA 支持: 渐进式 Web 应用体验
• 🌐 多语言支持: 中英文界面切换
• ⚡ 边缘计算: Cloudflare Pages 部署,全球加速
• 🔌 浏览器插件: 配套浏览器扩展,一键收藏网站到导航

为了提供更便捷的使用体验,我们开发了配套的浏览器扩展插件,让你可以一键收藏网站到 NavSphere 导航。

• 🚀 一键收藏: 在任意网页上一键添加到 NavSphere 导航
• 🎯 智能识别: 自动获取网站标题、描述和图标
• 📂 分类管理: 支持选择或创建分类目录
• 🔄 实时同步: 与 NavSphere 平台实时同步数据
• 🌐 多浏览器支持: 支持 Chrome、Firefox、Edge 等主流浏览器

1. 获取插件

   • 访问 NavSphere Extension
   • 下载最新版本或从应用商店安装(暂时未上架)

2. 配置连接

   • 在插件设置中配置你的 NavSphere 站点地址
   • 完成 GitHub 授权连接

3. 开始使用

   • 浏览任意网站时,点击插件图标
   • 选择分类并一键添加到导航

Deploy with Vercel

点击上方按钮即可一键部署到 Vercel,部署完成后需要配置环境变量。

• Node.js 18.0+
• pnpm 8.0+ (推荐) 或 npm/yarn
• GitHub 账户

1. 克隆项目

git clone https://github.com/tianyaxiang/NavSphere.git
cd NavSphere

2. 安装依赖

pnpm install

3. 配置环境变量

cp .env.example .env.local

4. 启动开发服务器

pnpm dev

5. 访问应用

   打开浏览器访问 http://localhost:3000

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

# GitHub OAuth App 配置
GITHUB_CLIENT_ID=your-github-client-id
GITHUB_SECRET=your-github-client-secret
# GitHub 仓库配置 
GITHUB_OWNER=your-github-username
GITHUB_REPO=your-repo-name
GITHUB_BRANCH=main
# NextAuth 配置
NEXTAUTH_URL=http://localhost:3000/api/auth
NEXT_PUBLIC_API_URL=http://localhost:3000

1. 创建 OAuth App

   • 访问 GitHub Developer Settings
   • 点击 "New OAuth App"
   • 填写应用信息:

     Application name: NavSphere
     Homepage URL: http://localhost:3000
     Authorization callback URL: http://localhost:3000/api/auth/callback/github
     

2. 获取凭据

   • Client ID: 应用详情页显示
   • Client Secret: 点击 "Generate a new client secret" 生成

1. 创建数据仓库

   • 访问 GitHub New Repository
   • 仓库名建议: navsphere-data
   • 可选择 Public 或 Private

2. 初始化数据文件

   项目会自动创建以下数据文件:

   • navigation.json - 导航数据
   • site.json - 站点配置
   • resources.json - 资源数据

在使用一键部署功能前,请确保完成以下准备工作:

• 创建 GitHub OAuth App 并获取 Client ID 和 Secret
• 创建用于存储数据的 GitHub 仓库
• 记录你的 GitHub 用户名和数据仓库名称
• 准备好你的 Vercel 项目域名(用于配置 NEXTAUTH_URL 和 NEXT_PUBLIC_API_URL)

1. 点击部署按钮

   Deploy with Vercel

2. 配置环境变量

   在部署过程中,Vercel 会要求你配置以下环境变量:

   GITHUB_CLIENT_ID=your-github-client-id
   GITHUB_SECRET=your-github-client-secret
   GITHUB_OWNER=your-github-username
   GITHUB_REPO=your-data-repo-name
   GITHUB_BRANCH=main
   NEXTAUTH_URL=https://your-project-name.vercel.app/api/auth
   NEXT_PUBLIC_API_URL=https://your-project-name.vercel.app

3. 更新 OAuth 回调地址

   部署完成后,需要在 GitHub OAuth App 设置中更新回调地址:

   https://your-project-name.vercel.app/api/auth/callback/github
   

1. Fork 项目到你的 GitHub

2. 连接 Vercel

   • 访问 Vercel Dashboard
   • 点击 "New Project"
   • 选择你 Fork 的仓库

3. 配置环境变量

   在 Vercel 项目设置中添加环境变量(同上)

4. 部署

   Vercel 会自动检测 Next.js 项目并进行部署

1. 创建项目

   • 登录 Cloudflare Pages
   • 连接 GitHub 仓库

2. 构建设置

   在 Cloudflare Pages 项目设置中配置:

   # 构建命令
   npx @cloudflare/next-on-pages@1
   # 输出目录
   .vercel/output/static
   # Node.js 版本
   18.17.0

3. 环境变量配置

   在 Cloudflare Pages 环境变量中添加:

   GITHUB_CLIENT_ID=your-github-client-id
   GITHUB_SECRET=your-github-client-secret
   GITHUB_OWNER=your-github-username
   GITHUB_REPO=your-repo-name
   GITHUB_BRANCH=main
   NEXTAUTH_URL=https://your-domain.pages.dev/api/auth
   NEXT_PUBLIC_API_URL=https://your-domain.pages.dev

4. 兼容性设置

   项目已包含 wrangler.toml 配置文件,确保 Cloudflare Pages 兼容性。

项目支持 Docker 容器化部署,适合自托管环境。

1. 克隆项目

git clone https://github.com/tianyaxiang/NavSphere.git
cd NavSphere

2. 配置环境变量

cp .env.example .env.local
# 编辑 .env.local 文件,配置必要的环境变量

1. 构建镜像

docker build -f docker/Dockerfile -t navsphere:latest .

2. 使用 Docker Compose

# 开发环境
docker-compose -f docker/docker-compose.yml up -d
# 生产环境
docker-compose -f docker/docker-compose.prod.yml up -d

3. 检查服务状态

# 查看容器状态
docker-compose -f docker/docker-compose.yml ps
# 查看日志
docker-compose -f docker/docker-compose.yml logs -f
# 停止服务
docker-compose -f docker/docker-compose.yml down

• 端口映射: 容器内部端口 3000 映射到主机端口 3000
• 环境变量: 通过 .env.local 文件注入
• 健康检查: 内置健康检查端点 /api/health
• 自动重启: 容器异常退出时自动重启

• Netlify: 需要配置构建命令
• Railway: 支持 Docker 部署
• 自托管: 支持 Docker 容器部署

项目使用 GitHub 仓库存储数据,自动创建以下文件:

[
 {
 "id": "dev-tools",
 "title": "开发工具",
 "icon": "🛠️",
 "items": [
 {
 "title": "GitHub",
 "titleEn": "GitHub", 
 "description": "代码托管平台",
 "descriptionEn": "Code hosting platform",
 "icon": "https://github.com/favicon.ico",
 "href": "https://github.com"
 }
 ],
 "subCategories": [
 {
 "id": "frontend",
 "title": "前端工具",
 "items": []
 }
 ]
 }
]

{
 "basic": {
 "title": "NavSphere",
 "description": "现代化导航管理平台",
 "keywords": "导航,书签,管理"
 },
 "appearance": {
 "logo": "/logo.png",
 "favicon": "/favicon.ico", 
 "theme": "system"
 }
}

# 开发模式
pnpm dev
# 构建项目
pnpm build
# 启动生产服务器
pnpm start
# 代码检查
pnpm lint
# 清理构建文件
pnpm clean

NavSphere/
├── app/ # Next.js App Router
│ ├── api/ # API 路由
│ ├── components/ # 页面组件
│ ├── globals.css # 全局样式
│ └── layout.tsx # 根布局
├── components/ # 共享组件
├── lib/ # 工具函数
├── public/ # 静态资源
├── styles/ # 样式文件
└── types/ # TypeScript 类型定义

如果这个项目对你有帮助,欢迎支持我们的开发工作!

打赏码

扫码支持 | 您的支持是我们持续开发的动力

Email | Twitter

我们欢迎所有形式的贡献!

1. 报告问题: 在 Issues 中报告 bug
2. 功能建议: 提出新功能想法
3. 代码贡献: 提交 Pull Request
4. 文档改进: 完善项目文档

1. Fork 项目
2. 创建功能分支: git checkout -b feature/amazing-feature
3. 提交更改: git commit -m 'Add amazing feature'
4. 推送分支: git push origin feature/amazing-feature
5. 创建 Pull Request

本项目基于 MIT License 开源协议。

• NavSphere Extension - 配套浏览器扩展插件
• NavSphere Docs - 详细文档和教程

• Next.js - 强大的 React 框架
• Tailwind CSS - 优秀的 CSS 框架
• Radix UI - 无障碍组件库
• Cloudflare Pages - 可靠的部署平台
• 所有为项目做出贡献的开发者

⭐ 如果这个项目对你有帮助,请给我们一个 Star!