Omnivore

GitHub

Omnivore是一个完整的、开源的稍后阅读解决方案，专为喜欢文字的人设计。

我们创建Omnivore是因为我们热爱阅读，并希望让阅读变得更加社交化。加入我们吧！

支持高亮、笔记、搜索和分享
全键盘导航
自动保存长文章的阅读进度
通过电子邮件添加新闻通讯文章（支持Substack！）
支持PDF
使用Node.js和TypeScript编写的网页应用
原生iOS应用（源码）
Android应用（源码）
为Android用户提供渐进式网页应用
浏览器扩展支持Chrome、Safari、Firefox和Edge
标签功能（又称标记）
离线支持
文字转语音（仅限iOS）
通过我们的Logseq插件支持Logseq
通过我们的Obsidian插件支持Obsidian

每个部分都是完全开源的！你可以分叉、扩展或部署到自己的服务器上。

我们还在omnivore.app提供免费的托管版Omnivore -- 立即试用吧！

在Discord上加入我们！:speech_balloon:

我们正在Discord上建立我们的社区。加入我们！

在我们的博客上了解更多关于Omnivore的信息。https://blog.omnivore.app/p/getting-started-with-omnivore

致谢 :tada:

Omnivore借鉴了一些优秀的开源软件：

TypeScript - 我们的大部分后端和前端都是用TypeScript编写的。
Next.js - 我们的前端是一个Next.JS应用，并托管在Vercel上。
SWR - 我们在网页上使用SWR进行所有的数据获取。
Stitches - 我们在前端使用Stitches来设计我们的组件样式。
Mozilla Readability - 我们使用Mozilla的Readability库来使页面更易阅读。
Swift GraphQL - 我们在iOS上使用Swift GraphQL生成GraphQL查询。
Apollo GraphQL - 我们在Android上使用Apollo GraphQL生成GraphQL查询。
Radix - 我们在前端使用Radix UI的组件。
还有许多其他优秀的库，只需查看我们的包文件就可以看到我们正在使用的库。

导入库

查看我们的文档以获取从其他应用导入数据的信息。

如何设置本地开发环境 :computer:

开始本地开发最简单的方法是使用docker compose up。这将启动一个postgres容器、我们的Web前端、API服务器和内容获取微服务。

开发要求

Omnivore使用TypeScript和JavaScript编写。

Node -- 目前我们使用Node.js v18.16
Chromium -- 安装信息见下文

运行Web和API服务

1. 启动docker compose

git clone https://github.com/omnivore-app/omnivore
cd omnivore
docker compose up

这将启动postgres，初始化数据库，并启动Web和API服务。

2. 打开浏览器

打开http://localhost:3000并确认Omnivore正在运行

3. 使用测试账户登录

在数据库设置期间，docker compose创建了一个账户demo@omnivore.app，密码：demo_password。

在浏览器中打开http://localhost:3000/，选择Continue with Email进行登录。

前端开发

如果你只想开发Omnivore的前端，可以使用docker compose运行后端服务，并在本地运行前端：

docker compose up api content-fetch
cd packages/web
cp .env.template .env.local
yarn dev

你需要在新的.env.local文件中配置一些值。这些是在主机上直接运行web服务，而在docker中运行api和content-fetch的值：

NEXT_PUBLIC_BASE_URL=http://localhost:3000
NEXT_PUBLIC_HIGHLIGHTS_BASE_URL=http://localhost:3000
NEXT_PUBLIC_LOCAL_BASE_URL=http://localhost:3000
NEXT_PUBLIC_SERVER_BASE_URL=http://localhost:4000
NEXT_PUBLIC_LOCAL_SERVER_BASE_URL=http://localhost:4000

在Docker外运行puppeteer-parse服务

要保存页面，你需要运行puppeteer-parse服务。

1. 安装并配置Chromium

brew install chromium --no-quarantine
export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
export CHROMIUM_PATH=`which chromium`

2. 导航到服务目录，设置环境文件，并安装依赖

cd packages/puppeteer-parse
cp .env.example .env
yarn

3. 启动服务

yarn start

这将在9090端口启动puppeteer-parse服务。

在浏览器中打开http://localhost:3000/home，点击Add Link按钮，输入一个URL，例如https://blog.omnivore.app/p/getting-started-with-omnivore。

你应该会看到一个Chromium窗口打开并导航到你的链接。当服务完成获取你的内容后，你将在你的库中看到它。

如何部署到你自己的服务器

Omnivore 最初设计为部署在 GCP 上，并利用了一些 GCP 的 PaaS 功能。我们正在努力使 Omnivore 更加便携，以便您可以轻松地在自己的基础设施上运行该服务。您可以在这里跟踪进度：https://github.com/omnivore-app/omnivore/issues/25

要在自己的硬件上部署 Omnivore，您需要部署三个容器化服务并配置对 postgres 服务的访问。要处理 PDF 文档，您需要配置对 Google Cloud Storage 存储桶的访问。

packages/api - 后端 API 服务
packages/web - Web 前端（可轻松部署到 Vercel）
packages/puppeteer-parse - 内容获取服务（可轻松部署为 AWS Lambda 或 GCP Cloud Function）

此外，您需要运行我们的数据库迁移来初始化您的数据库。这些已经容器化，可以通过 packages/db 服务运行。

许可证

Omnivore 和我们对 Readability.js 的扩展均采用 AGPL-3.0 许可证。