快速开始指南

5分钟快速部署和使用 Webooks 现代化书签管理工具。

环境要求

Node.js

版本 18.0 或更高

下载 Node.js

包管理器

npm 8.0+ 或 pnpm 7.0+

npm 通常随 Node.js 自动安装

数据库

PostgreSQL 13+ 或 SQLite

SQLite 无需额外配置

现代浏览器

Chrome 90+、Firefox 88+、Safari 14+、Edge 90+

安装步骤

1

克隆项目

从 GitHub 克隆 Webooks 项目到本地:

git clone https://github.com/yourusername/webooks.git
cd webooks
提示: 如果没有 Git,可以从 GitHub 下载 ZIP 文件并解压。
2

安装依赖

安装项目所需的依赖包:

npm install
# 或使用 pnpm
pnpm install
注意: 安装过程可能需要几分钟,请耐心等待。
3

配置环境变量

复制环境变量模板并编辑配置:

cp .env.example .env

编辑 .env 文件,配置以下关键参数:

# 数据库配置
DATABASE_URL="postgresql://username:password@localhost:5432/webooks"
# 或使用 SQLite(推荐用于测试)
DATABASE_URL="file:./dev.db"

# 应用配置
NEXTAUTH_URL="http://localhost:3000"
NEXTAUTH_SECRET="your-secret-key-here"

# JWT 密钥(使用随机字符串)
JWT_SECRET="your-jwt-secret-key"
4

初始化数据库

运行数据库迁移和生成 Prisma 客户端:

npx prisma migrate dev --name init
npx prisma generate
提示: 如果使用 SQLite,这一步会自动创建数据库文件。
5

启动服务

启动开发服务器:

npm run dev

服务启动后,访问 http://localhost:3000 查看应用。

首次使用

首次访问应用时,系统会自动检测并引导您完成初始化设置:

🚀

系统初始化

访问应用主页,系统会自动检测需要初始化

👤

创建管理员账户

设置管理员用户名和密码(测试密码:admin123)

📁

创建默认空间

系统会自动创建默认的书签空间和文件夹结构

开始使用

初始化完成后,您可以开始添加和管理书签

重要: 请妥善保管管理员账户信息,这是访问管理后台的唯一方式。

基础操作

书签管理

添加书签

  1. 点击"添加书签"按钮
  2. 输入书签标题和 URL
  3. 选择文件夹和标签
  4. 保存书签

编辑书签

  1. 右键点击书签
  2. 选择"编辑"选项
  3. 修改信息并保存

删除书签

  1. 选择要删除的书签
  2. 点击删除按钮
  3. 确认删除操作

移动书签

  1. 拖拽书签到目标文件夹
  2. 或使用右键菜单移动

导入书签

Webooks 支持导入多种浏览器的书签格式:

支持的浏览器

Google Chrome

导出步骤:设置 → 书签 → 书签管理器 → 导出书签

Mozilla Firefox

导出步骤:库 → 书签 → 管理所有书签 → 导出书签到 HTML

Microsoft Edge

导出步骤:设置 → 收藏夹 → 导出收藏夹

导入步骤

1

准备书签文件

从浏览器导出书签为 HTML 文件(NETSCAPE-Bookmark-file-1 格式)

2

访问管理后台

访问 http://localhost:3000/admin

3

上传书签文件

在书签管理页面选择"导入书签",上传书签文件

4

选择导入选项

选择是否保留现有书签、是否创建文件夹结构等

5

开始导入

点击导入按钮,系统会自动解析并分类书签

管理书签

空间管理

空间(Space)是最高级别的分类单位,可以理解为不同用途或不同项目的书签集合。

  • 创建新的工作空间用于项目管理
  • 为不同主题创建专门的空间
  • 在不同空间之间切换浏览

文件夹管理

文件夹(Folder)用于在空间内进一步组织书签。

  • 创建嵌套的文件夹结构
  • 拖拽移动文件夹到不同位置
  • 批量管理文件夹内的书签

标签系统

标签为书签提供额外的分类维度,便于跨文件夹搜索和筛选。

  • 为书签添加多个标签
  • 使用标签快速筛选书签
  • 标签支持颜色分类

管理后台

管理后台提供完整的系统管理功能:

书签管理

  • 查看所有书签列表
  • 批量编辑和删除书签
  • 导入和导出书签
  • 检查重复书签

文件夹管理

  • 创建和编辑文件夹
  • 调整文件夹层级结构
  • 批量移动书签
  • 删除空文件夹

空间管理

  • 创建和管理多个空间
  • 设置空间访问权限
  • 空间统计信息
  • 备份和恢复空间

系统管理

  • 用户账户管理
  • 系统配置设置
  • 数据库维护
  • 日志查看
注意: 管理后台需要管理员权限,请使用初始化时创建的账户登录。