176 lines
7.3 KiB
Markdown
176 lines
7.3 KiB
Markdown
|
# Omnivore
|
||
|
|
|
||
|
|
[](https://github.com/omnivore-app/omnivore/actions/workflows/run-tests.yaml)
|
||
|
|
[](https://discord.gg/h2z5rppzz9)
|
||
|
|
[](https://pkm.social/@omnivore)
|
||
|
|
[](https://twitter.com/OmnivoreApp)
|
||
|
|
|
||
|
|
|
||
|
|
<img align="right" src="https://avatars.githubusercontent.com/u/70113176?s=400&u=506b21d9f019f3160963c010ef363667fb24c7c9&v=4" height="150px" alt="Omnivore Logo">
|
||
|
|
|
||
|
|
[Omnivore](https://omnivore.app) is a complete, open source read-it-later solution for people who like text.
|
||
|
|
|
||
|
|
We built Omnivore because we love reading and we want it to be more social. Join us!
|
||
|
|
|
||
|
|
- Highlighting, notes, search, and sharing
|
||
|
|
- Full keyboard navigation
|
||
|
|
- Automatically saves your place in long articles
|
||
|
|
- Add newsletter articles via email (with substack support!)
|
||
|
|
- PDF support
|
||
|
|
- [Web app](https://omnivore.app/) written in Node.js and TypeScript
|
||
|
|
- [Native iOS app](https://omnivore.app/install/ios) ([source](https://github.com/omnivore-app/omnivore/tree/main/apple))
|
||
|
|
- [Android app](https://omnivore.app/install/android) ([source](https://github.com/omnivore-app/omnivore/tree/main/android/Omnivore))
|
||
|
|
- Progressive web app for Android users
|
||
|
|
- Browser extensions for [Chrome](https://omnivore.app/install/chrome), [Safari](https://omnivore.app/install/safari), [Firefox](https://omnivore.app/install/firefox), and [Edge](https://omnivore.app/install/edge)
|
||
|
|
- Labels (aka tagging)
|
||
|
|
- Offline support
|
||
|
|
- Text to speech (iOS only)
|
||
|
|
- [Logseq](https://logseq.com/) support via our [Logseq Plugin](https://github.com/omnivore-app/logseq-omnivore)
|
||
|
|
- [Obsidian](https://obsidian.md/) support via our [Obsidian Plugin](https://github.com/omnivore-app/obsidian-omnivore)
|
||
|
|
|
||
|
|
Every single part is fully open source! Fork it, extend it, or deploy it to your own server.
|
||
|
|
|
||
|
|
We also have a free hosted version of Omnivore at [omnivore.app](https://omnivore.app/) -- try it now!
|
||
|
|
|
||
|
|
<img width="981" alt="web-screenshot-listview" src="https://github.com/omnivore-app/omnivore/assets/75189/df7c797a-4255-42f4-a686-ad94866cb580">
|
||
|
|
|
||
|
|
## Join us on Discord! :speech_balloon:
|
||
|
|
|
||
|
|
We're building our community on Discord. [Join us!](https://discord.gg/h2z5rppzz9)
|
||
|
|
|
||
|
|
Read more about Omnivore on our blog. <https://blog.omnivore.app/p/getting-started-with-omnivore>
|
||
|
|
|
||
|
|
## Shoutouts :tada:
|
||
|
|
|
||
|
|
Omnivore takes advantage of some great open source software:
|
||
|
|
|
||
|
|
- [TypeScript](https://www.typescriptlang.org/) - Most of our backend and frontend are written in TypeScript.
|
||
|
|
- [Next.js](https://nextjs.org/) - Our frontend is a Next.JS app and is hosted on [Vercel](https://vercel.com/).
|
||
|
|
- [SWR](https://swr.vercel.app/) - We do all our data fetching on the web using SWR.
|
||
|
|
- [Stitches](https://stitches.dev/) - We use Stitches on the frontend to style our components.
|
||
|
|
- [Mozilla Readability](https://github.com/mozilla/readability) - We use Mozilla's Readability library to make pages easier to read.
|
||
|
|
- [Swift GraphQL](https://www.swift-graphql.com/) - We generate our GraphQL queries on iOS using Swift GraphQL.
|
||
|
|
- [Radix](https://www.radix-ui.com/) - We use Radix UI's components on our frontend.
|
||
|
|
- And many more awesome libraries, just checkout our package files to see what we are using.
|
||
|
|
|
||
|
|
## Importing Libraries
|
||
|
|
|
||
|
|
If you have a library you'd like to import, [@davidohlin](https://github.com/davidohlin) has created
|
||
|
|
a tool that imports a list of CSV URLs: [omnivore-import](https://github.com/davidohlin/instapaper-to-omnivore-import)
|
||
|
|
|
||
|
|
## How to setup local development :computer:
|
||
|
|
|
||
|
|
The easiest way to get started with local development is to use `docker compose up`. This will start a postgres container, our web frontend, an API server, and our content fetching microservice.
|
||
|
|
|
||
|
|
### Requirements for development
|
||
|
|
|
||
|
|
Omnivore is written in TypeScript and JavaScript.
|
||
|
|
|
||
|
|
- [Node](https://nodejs.org/) -- currently we are using Node.js v14.18
|
||
|
|
- [Chromium](https://www.chromium.org/chromium-projects/) -- see below for installation info
|
||
|
|
|
||
|
|
### Running the web and API services
|
||
|
|
|
||
|
|
### 1. Start docker compose
|
||
|
|
|
||
|
|
```bash
|
||
|
|
git clone https://github.com/omnivore-app/omnivore
|
||
|
|
cd omnivore
|
||
|
|
docker compose up
|
||
|
|
```
|
||
|
|
|
||
|
|
This will start postgres, initialize the database, and start the web and api services.
|
||
|
|
|
||
|
|
### 2. Open the browser
|
||
|
|
|
||
|
|
Open <http://localhost:3000> and confirm Omnivore is running
|
||
|
|
|
||
|
|
### 3. Login with the test account
|
||
|
|
|
||
|
|
During database setup docker compose creates an account `demo@omnivore.app`, password: `demo_password`.
|
||
|
|
|
||
|
|
Go to <http://localhost:3000/> in your browser and choose `Continue with Email` to login.
|
||
|
|
|
||
|
|
### Frontend Development
|
||
|
|
|
||
|
|
If you want to work on just the frontend of Omnivore you can run the backend services
|
||
|
|
with docker compose and the frontend locally:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
docker compose up api content-fetch
|
||
|
|
cd packages/web
|
||
|
|
cp .env.template .env.local
|
||
|
|
yarn dev
|
||
|
|
```
|
||
|
|
|
||
|
|
You will need to configure some values in the new `.env.local` file. These are
|
||
|
|
the values for running the `web` service directly on your host machine and
|
||
|
|
running `api` and `content-fetch` within docker:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
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
|
||
|
|
```
|
||
|
|
|
||
|
|
### Running the puppeteer-parse service outside of Docker
|
||
|
|
|
||
|
|
To save pages you need to run the `puppeteer-parse` service.
|
||
|
|
|
||
|
|
### 1. Install and configure Chromium
|
||
|
|
|
||
|
|
```
|
||
|
|
brew install chromium --no-quarantine
|
||
|
|
export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
|
||
|
|
export CHROMIUM_PATH=`which chromium`
|
||
|
|
```
|
||
|
|
|
||
|
|
### 2. Navigate to the service directory, setup your env file, and install dependencies
|
||
|
|
|
||
|
|
```
|
||
|
|
cd packages/puppeteer-parse
|
||
|
|
cp .env.example .env
|
||
|
|
yarn
|
||
|
|
```
|
||
|
|
|
||
|
|
### 3. Start the service
|
||
|
|
|
||
|
|
```
|
||
|
|
yarn start
|
||
|
|
```
|
||
|
|
|
||
|
|
This will start the puppeteer-parse service on port 9090.
|
||
|
|
|
||
|
|
In your browser go to <http://localhost:3000/home>, click the `Add Link` button,
|
||
|
|
and enter a URL such as `https://blog.omnivore.app/p/getting-started-with-omnivore`.
|
||
|
|
|
||
|
|
You should see a Chromium window open and navigate to your link. When the service
|
||
|
|
is done fetching your content you will see it in your library.
|
||
|
|
|
||
|
|
## How to deploy to your own server
|
||
|
|
|
||
|
|
Omnivore was originally designed to be deployed on GCP and takes advantage
|
||
|
|
of some of GCP's PaaS features. We are working to make Omnivore more portable
|
||
|
|
so you can easily run the service on your own infrastructure. You can track
|
||
|
|
progress here: https://github.com/omnivore-app/omnivore/issues/25
|
||
|
|
|
||
|
|
To deploy Omnivore on your own hardware you will need to deploy three
|
||
|
|
dockerized services and configure access to a postgres service. To handle
|
||
|
|
PDF documents you will need to configure access to a Google Cloud Storage
|
||
|
|
bucket.
|
||
|
|
|
||
|
|
- `packages/api` - the backend API service
|
||
|
|
- `packages/web` - the web frontend (can easily be deployed to vercel)
|
||
|
|
- `packages/puppeteer-parse` - the content fetching service (can easily
|
||
|
|
be deployed as an AWS lambda or GCP Cloud Function)
|
||
|
|
|
||
|
|
Additionally, you will need to run our database migrations to initialize
|
||
|
|
your database. These are dockerized and can be run with the
|
||
|
|
`packages/db` service.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Omnivore and our extensions to Readability.js are under the AGPL-3.0 license.
|