Flow - 开源软件 (OSS)
重新定义 ePub 阅读器
免费。开源。基于浏览器。
功能
- 网格布局
- 书内搜索
- 图片预览
- 自定义排版
- 高亮和注释
- 主题
- 通过链接分享/下载书籍
- 数据导出
- 云存储
关于计划中的功能,请查看我们的路线图。
开发
先决条件
克隆仓库
git clone https://github.com/pacexy/flow
安装依赖
pnpm i
设置环境变量
复制并重命名所有 .env.local.example
文件为 .env.local
,然后设置环境变量。
运行应用
pnpm dev
自托管
在自托管之前,你应该设置环境变量。
Docker
你可以使用 docker-compose:
docker compose up -d
或者手动构建镜像并运行:
docker build -t flow .
docker run -p 3000:3000 --env-file apps/reader/.env.local flow
贡献
你可以通过多种方式参与这个项目,例如:
- 提交 bug 和功能请求,并在它们被检查时帮助验证
- 提交拉取请求