init: create project

README.md

@@ -0,0 +1,166 @@
+# Privacy
+
+![GitHub last commit](https://img.shields.io/github/last-commit/kallydev/privacy?style=flat-square)
+![GitHub commit activity](https://img.shields.io/github/commit-activity/m/kallydev/privacy?style=flat-square)
+![GitHub license](https://img.shields.io/github/license/kallydev/privacy?style=flat-square)
+
+个人数据泄漏检测网站，适用于近期流传的 40GB+ 数据。
+
+## 示例截图
+
+![screenshot](screenshot/screenshot.png)
+
+可以前往预览 [示例网站](https://privacy.kallydev.com/)（暂未部署最新版本）。
+
+## 使用方法
+
+### 导入数据
+
+数据来源于近期流传的 40GB+ 的压缩包，目前已支持 QQ / JD / SF 的多表查询。
+
+1. 创建 SQLite 数据库
+
+```bash
+sqlite3 database.db
+```
+
+分别执行以下 SQL 语句，用于创建 QQ / 京东 / 顺丰数据表。
+
+```sql
+CREATE TABLE IF NOT EXISTS qq
+(
+    id           BIGINT,
+    qq_number    BIGINT,
+    phone_number INT
+);
+```
+
+```sql
+CREATE TABLE IF NOT EXISTS jd
+(
+    id           BIGINT,
+    name         TEXT,
+    nickname     TEXT,
+    password     TEXT,
+    email        TEXT,
+    id_number    TEXT,
+    phone_number INT
+);
+```
+
+```sql
+CREATE TABLE IF NOT EXISTS sf
+(
+    id           BIGINT,
+    name         TEXT,
+    phone_number INT,
+    address      TEXT
+);
+```
+
+2. 导入 QQ 库
+
+把 `6.9更新总库.txt` 文件放到 `database` 目录下，然后执行 `qq.py`。
+
+3.导入京东库
+
+把 `www_jd_com_12g.txt` 文件放到 `database` 目录下，然后执行 `jd.py`。
+
+- 创建索引
+
+```bash
+sqlite3 database.db
+```
+
+```sql
+CREATE INDEX index_qq ON qq (qq, phone);
+CREATE INDEX index_jd ON jd (email, id_number, phone_number, phone_number);
+```
+
+4. 导入顺丰库
+
+还没来得及写，欢迎 PR 或者等我明天再写。
+
+### 编译代码
+
+1. 安装 Yarn
+
+```bash
+npm install -g yarn
+```
+
+2. 安装 Golang
+
+```bash
+sudo apt install -y snap
+sudo snap install golang --classic
+```
+
+3. 下载源代码
+
+```bash
+git clone http://github.com/kallydev/privacy
+```
+
+4. 编译前端
+
+```bash
+cd privacy
+yarn install
+yarn build
+```
+
+5. 编译后端
+
+```bash
+cd ../server
+go build -o app main/main.go
+```
+
+### 运行
+
+修改 `config.yaml` 配置文件，然后直接运行后端。
+
+```bash
+./app --config config.yaml
+```
+
+## TODO
+
+- [ ] 编译 Docker 镜像
+- [ ] 取模分表
+- [ ] 微博账号和手机号关联查询
+- [ ] 重构所有导入脚本以及编写微博和顺丰的导入脚本
+- [ ] 自动加载支持的数据表
+- [ ] 示例网站支持以上新的功能
+
+## Q&A
+
+### 1. 为什么代码和文档都写的这么生草？
+
+我当时只是随口说了一个时间，结果才发现时间安排得有亿点紧，于是就放飞自我了。之后会逐步进行重构，**同时也欢迎发起 PR**。
+
+### 2. 部署或使用遇到问题如何解决?
+
+1. 在这个 Repo 发起 Issues，空余时间我会协助你解决。
+2. 把错误信息粘贴到 `https://stackoverflow.com/search?q=` 这个链接后面，然后浏览器打开。
+3. 因为个人并不喜欢回复 PM，所以 Telegram 之类问我问题的不太可能会回复。
+4. 通往罗马的道路千万条慢，自己努力吧少年。
+
+### 3. 为什么示例网站只支持 QQ 和手机号关系查询?
+
+示例服务器的硬盘不够，而且这些大文件传输特别麻烦，先搁置一段时间。
+
+### 4. 为什么导入脚本会提示出现无效数据?
+
+因为源数据的格式实在是太乱了，存在大量错排。脚本会自动忽略这些解析失败的数据。
+
+### 5. 为什么不提供数据库文件?
+
+众所周知传播这些数据属于违法行为，所以这个项目不提供相关数据。
+
+## License
+
+Copyright (c) KallyDev. All rights reserved.
+
+Licensed under the [MIT](LICENSE).