From 62311e0d6a79dbd6d17797cb64d91864e75bdf58 Mon Sep 17 00:00:00 2001 From: rbarbazz <42906704+rbarbazz@users.noreply.github.com> Date: Thu, 24 Oct 2024 13:36:55 -0700 Subject: [PATCH] Format README --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c9abd789d..55d301557 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ Omnivore is written in TypeScript and JavaScript. ### Running the web and API services -### 1. Start docker compose +#### 1. Start docker compose ```bash git clone https://github.com/omnivore-app/omnivore @@ -81,11 +81,11 @@ docker compose up This will start postgres, initialize the database, and start the web and api services. -### 2. Open the browser +#### 2. Open the browser Open and confirm Omnivore is running -### 3. Login with the test account +#### 3. Login with the test account During database setup docker compose creates an account `demo@omnivore.app`, password: `demo_password`. @@ -119,25 +119,25 @@ NEXT_PUBLIC_LOCAL_SERVER_BASE_URL=http://localhost:4000 To save pages you need to run the `puppeteer-parse` service. -### 1. Install and configure Chromium +#### 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 +#### 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 +#### 3. Start the service -``` +```bash yarn start ``` @@ -154,7 +154,7 @@ is done fetching your content you will see it in your library. 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 +progress here: To deploy Omnivore on your own hardware you will need to deploy three dockerized services and configure access to a postgres service. To handle