# MarkSync

**Repository Path**: zcoolq/mark-sync

## Basic Information

- **Project Name**: MarkSync
- **Description**: 书签同步系统
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-09
- **Last Updated**: 2026-07-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MarkSync

轻量级书签同步系统 — 浏览器扩展 + 后端 API + Web 管理台三件套。

> **v3.0 (2026-07)** — 全面重写同步引擎为**可靠的双向增量同步**：
> UUID 主键、字段级 LWW 冲突解决、删除墓碑、`server_updated_at` 增量拉取、`force` 强制覆盖。
> 旧版基于 `path` 的单向推送默认不兼容；升级时服务端会自动 DROP 旧 `bookmarks` 表（仅书签数据，用户/Token 保留）。详见 [`docs/CHANGELOG.md`](docs/CHANGELOG.md) 与 [`docs/DEPLOYMENT.md`](docs/DEPLOYMENT.md).

## 组成

- **`extension/`** — Chrome/Firefox 扩展（Manifest V3），基于 BookmarkSync 改造，支持 Gitee Gist + 自建后端双模式
- **`backend/`** — Bun + Hono + SQLite 后端 API（用户、Token、书签同步）
- **`web/`** — Vue 3 + Naive UI 管理台（登录、书签管理、Token 管理）
- **`deploy/`** — docker-compose + Dockerfile + 部署脚本
- **`docs/`** — 架构、API、部署文档

## 快速开始

### 生产部署（推荐）

```bash
cd deploy
docker compose up -d
```

访问：https://marksync.zcoolq.cn（走 Cloudflare Tunnel）

### 本地开发

```bash
# 后端
cd backend && npm install && npm run dev

# 前端
cd web && npm install && npm run dev

# 扩展
# Chrome → chrome://extensions → 加载已解压 → 选 extension/
```

## 技术栈

| 层 | 技术 |
|----|------|
| 后端 | Node 22 + Hono + better-sqlite3 |
| 前端 | Vue 3 + Vite + Naive UI + Pinia |
| 扩展 | 原生 JS + Manifest V3 |
| 认证 | JWT (HS256) + Argon2 |
| 部署 | Docker Compose + Cloudflare Tunnel |

## 文档

- [架构设计](./docs/ARCHITECTURE.md)
- [API 规范](./docs/API.md)
- [部署指南](./docs/DEPLOYMENT.md)
- [扩展改造说明](./docs/EXTENSION.md)