base on Omnivore is a complete, open source read-it-later solution for people who like reading. # 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. - [Apollo GraphQL](https://www.apollographql.com/) - We generate our GraphQL queries on Android using Apollo 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 Check out our [docs](https://docs.omnivore.app/using/importing.html) for information on importing your data from other apps. ## 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.js](https://nodejs.org/) (v18.16) and [Yarn](https://classic.yarnpkg.com/lang/en/) -- Versions are managed by [Volta](https://docs.volta.sh/guide/getting-started). - [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 `[email protected]`, 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 ```bash 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 ```bash cd packages/puppeteer-parse cp .env.example .env yarn ``` #### 3. Start the service ```bash 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. ", Assign "at most 3 tags" to the expected json: {"id":"2389","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"