Webooks 文档

欢迎使用 Webooks 现代化书签管理工具的完整文档。

快速链接

🚀

快速开始

5分钟快速部署和使用指南
📚

API 文档

完整的 RESTful API 参考
⚡

部署指南

多种部署方式的详细说明
❓

常见问题

常见问题解答和故障排除

项目概述

Webooks 是一个功能强大的现代化书签管理工具，专为提高浏览效率而设计。它支持多种浏览器的书签格式导入导出，提供灵活的空间和文件夹分类管理，并具备强大的搜索和标签功能。

核心特性

  • 智能书签导入：支持 NETSCAPE-Bookmark-file-1 格式，自动识别 Chrome、Edge、Firefox 等浏览器导出的书签
  • 分类管理：灵活的空间（Space）和文件夹（Folder）组织结构
  • 高级搜索：全文搜索书签标题、描述和 URL，支持标签筛选
  • 标签系统：多标签分类，支持快速筛选和批量操作
  • 响应式设计：完美适配桌面和移动设备
  • 多语言支持：内置中英文双语界面
  • RESTful API：完整的 API 支持，方便集成和扩展

技术栈

前端

  • Next.js 14.2.33
  • React 18
  • TypeScript
  • Tailwind CSS
  • Lucide React (图标)

后端

  • Next.js API Routes
  • Prisma ORM
  • PostgreSQL/SQLite
  • JWT 认证
  • bcryptjs (密码加密)

工具链

  • ESLint 代码检查
  • PostCSS 样式处理
  • Prisma 数据库管理
  • Cheerio 网页抓取

环境要求

Node.js

版本 18.0 或更高

包管理器

npm 8.0+ 或 pnpm 7.0+

浏览器

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

数据库

PostgreSQL 13+ 或 SQLite

快速安装

1

克隆项目

git clone https://github.com/yourusername/webooks.git
cd webooks
2

安装依赖

npm install
# 或使用 pnpm
pnpm install
3

配置环境

cp .env.example .env
# 编辑 .env 文件，配置数据库连接等信息
4

初始化数据库

npx prisma migrate dev
npx prisma generate
5

启动服务

# 开发模式
npm run dev

# 生产模式
npm run build
npm start