Beautiful Album

简介

使用Vue编写的，iOS相册风格的，纯静态响应式布局的在线相册。

在线Demo (密码为secret)

• 纯静态网页，运行时不需要任何后端程序和数据库，可存放在github.io。
• 支持多个相册，访问时支持密码保护

超越妹妹真的太可爱啦！！！

如何使用？

方式1、 使用bootstrap.sh脚本自动化构建

注意：

• Windows用户需要使用msys2，git-bash或者WSL运行这个脚本。
• NodeJS版本建议使用node 16版本。

Step 1. 组织相册

在任意地方新建一个一个目录，作为相册目录，例如 ~/my_album

在这个相册目录下，按照下面的规则组织相册：

1. 每一个子目录都是一个相册，建议使用英语名，例如：cutecy。
2. 新建一个和之前的目录名同名的.txt文件可以自定义一个好看的名称。例如新建cutecy.txt，并在该文件中保存文本作为显示在界面中的相册名（例如：超越妹妹可可爱爱）。
3. 在每个相册的目录都可以放入任意的图片。

一个组织好的目录结构如下

~/my_album
├── cutecy
│   ├── 1.jpg
│   └── 2.jpg
├── cutecy.txt
├── photos
│   ├── IMG_0001.jpg
│   └── IMG_0002.jpg
└── photos.txt

Step 2. 运行脚本

脚本会检查所需要的环境和依赖，如果提示缺少依赖，需要手动安装。

• 通过 --prefix 参数传入你想要生成API的目标目录，例如 /mnt/data/wwwroot
• 通过 --album-dir 参数传入上面步骤创建的相册目录，例如 ~/my_album

常用的使用方法如下：

• 编译项目，并生成API，创建一个密码为1234的相册

  ./bootstrap.sh --center-face \
             --password=1234 \
             --prefix=/mnt/data/wwwroot \
             --album-dir=~/my_album

• 不编译项目，只重新生成API（适用于更新相册）

  ./bootstrap.sh --generate-api-only \
             --center-face \
             --password=1234 \
             --prefix=/mnt/data/wwwroot \
             --album-dir=~/my_album

• 只编译项目，不重新生成API（适用于更新程序）

  ./bootstrap.sh --build-webpage-only \
             --center-face \
             --password=1234 \
             --prefix=/mnt/data/wwwroot \
             --album-dir=~/my_album

• 更多参数和功能请参考帮助说明

  
  usage: ./bootstrap.sh [OPTIONS] ...

Options: --prefix=PREFIX 指定生成最终打包的程序文件和API文档的位置 --album-dir=DIR 指定相册的目录（具体结构见下方说明） --center-face 做人脸检测，以使人脸居中显示在主界面预览中，见下方详细说明 --face-detector=DETECTOR_NAME
指定用于人脸检测的推理前端，见下方详细说明 --face-detector-model=MODEL_NAME 指定用于人脸检测的模型，见下方详细说明 --face-clustering 生成“人物”功能所需API，见下方详细说明 --password=PWD 指定相册的密码 --build-webpage-only 只编译网站项目，不生成API --generate-api-only 不编译项目，只重新生成API（适用于更新相册） --copy-resource 不重新编译网站，但是复制编译好的网站项目文件到--prefix指定的目录 --python-path=NAME 指定python命令的位置，默认：python --disable-cache 在生成缩略图的时候不使用缓存，全部重新生成 --install-deps 安装npm依赖，相当于在项目目录运行 'npm build' --disable-share 禁用“分享”功能，不生成相关的API --use-symlink 生成用于“分享”功能的API时，使用符号链接而不是拷贝文件 --help, -h 显示帮助信息 -- -- 后面所有的参数将被传递给'scripts/generate_api.py'

**人脸居中功能：人脸检测说明**

可用的推理前端包括以下几种，可使用 `--face-detector` 参数传入，可用 `--face-detector-model` 指定要使用的模型。

* [opencv](https://github.com/opencv/opencv)
* [deepface](https://github.com/serengil/deepface)：使用 `pip install deepface` 安装，默认使用 `yolov8`后端进行人脸检测。在运行时如提示缺少包可以按照提示安装。

使用deepface后端可以利用CUDA进行人脸识别（更快）。

例如，使用deepface和yolov8进行人脸检测生成API，可执行下面的命令
```bash 
./bootstrap.sh --generate-api-only \
               --center-face \
               --password=1234 \
               --prefix=/mnt/data/wwwroot \
               --album-dir=~/my_album \
               --face-detector=deepface --face-detector-model=yolov8

“人物”分类功能说明

使用人物分类功能（使用--face-clustering参数）可以将所有照片中同一个人的照片“尽可能地”提取出来形成一个分类。进行人物分类时仅可使用 deepface 作为推理框架。

./bootstrap.sh --generate-api-only \
               --center-face \
               --password=1234 \
               --prefix=/mnt/data/wwwroot \
               --album-dir=~/my_album \
               --face-detector=deepface --face-detector-model=yolov8 \
               --face-clustering 

指定自定义的聚类参数

./bootstrap.sh --generate-api-only \
               --center-face \
               --password=1234 \
               --prefix=/mnt/data/wwwroot \
               --album-dir=~/my_album \
               --face-detector=deepface --face-detector-model=yolov8 \
               --face-clustering \
               -- --face_clustering_eps=0.7 --face_clustering_min_samples=4

方式2、 手动构建

首先，编译Web项目

0. 安装依赖： npm install
1. 构建项目： npm run build，生成的代码在dist目录下。复制所有dist目录下的文件到nginx的web root根目录。

然后生成图片缓存以及相关json文件

0. 安装依赖：pip3 install numpy pillow

1. 在scripts目录下，新建一个album目录，这个目录用来存放相册。

2. 在album目录下新建目录，每一个目录都是一个相册，建议使用英语名，例如：cutecy。 新建一个和之前的目录名同名的.txt文件可以自定义一个好看的名称， 例如新建cutecy.txt，并在该文件中保存文本作为显示在界面中的相册名（例如：超越妹妹可可爱爱）。在每个相册的目录都可以放入任意的图片。

3. 运行 generate_api.py。 如果需要密码访问该相册，传入参数 --password=mypassword。

4. 在nginx的web root根目录下新建一个api目录，并将albums、album-caches以及生成的所有json文件放入该目录。

注意：之后每一次更新完照片以后，都需要重新执行上述4-5步骤。

上述过程的shell脚本：

git clone https://github.com/acane77/BeautifulAlbum
cd BeautifulAlbum

# 编译项目
npm install
npm run build

# 生成需要的文件
cd scripts

# 安装依赖
pip install pillow numpy

# 创建相册
mkdir album

# 创建一个名为cute的相册
mkdir album/cutecy
echo "可可爱爱">album/cutecy.txt
# 复制图片进去
cp /path/to/your/image/dir/*.jpg album/cutecy

# 生成相关的文件
# -- 生成API过程中，人脸检测将会消耗更多的时间。如果不想使用人脸框居中功能，请去掉 --center_face 参数。
# -- 如果不想使用密码功能，请去掉 --password 参数
python generate_api.py --center_face --password="mypassword"

# 生成用于分享的API
bash ./build_hash2lib.sh

# 组织生成的文件
mkdir ../dist/api
cp -r albums ../dist/api
cp -r album-caches ../dist/api
cp *.json ../dist/api
cd ..

然后可以使用http-server里面直接打开看看有没有配置好

cd dist     # npm构建目录
npm install -g http-server
http-server .

也可以打包传到服务器上

cd dist
tar czf album-website.tar.gz *
scp album-website.tar.gz $YOUR_SERVER

by Miyuki, 2020.1, Licensed under MIT license