diff --git a/README.md b/README.md index 2de5a3734..b7472c079 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ 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! @@ -44,14 +43,14 @@ Read more about Omnivore on our blog. and confirm Omnivore is running ### 3. Login with the test account -During database setup docker-compose creates an account `demo@omnivore.app`, password: `demo`. +During database setup docker compose creates an account `demo@omnivore.app`, password: `demo`. Go to in your browser and choose `Continue with Email` to login. @@ -97,7 +96,7 @@ If you want to work on just the frontend of Omnivore you can run the backend ser with docker compose and the frontend locally: ```bash -docker-compose up api content-fetch +docker compose up api content-fetch cd packages/web cp .env.template .env yarn dev @@ -137,7 +136,6 @@ and enter a URL such as `https://blog.omnivore.app/p/getting-started-with-omnivo 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 @@ -153,7 +151,7 @@ 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) + 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 @@ -162,4 +160,3 @@ your database. These are dockerized and can be run with the ## License Omnivore and our extensions to Readability.js are under the AGPL-3.0 license. - diff --git a/packages/api/README.md b/packages/api/README.md index 847ba6c16..97585b22a 100644 --- a/packages/api/README.md +++ b/packages/api/README.md @@ -20,13 +20,13 @@ Because we make use of Row Level Security in the database, - all operations typi We use ElasticSearch to store page data in a distributed manner. This is a great way to store data that is not easily searchable. All the page data is stored in a single index `pages`. This index is then queried by the app to display the data. -You need to make sure you have an elasticsearch instance running locally (or just use docker-compose). +You need to make sure you have an elasticsearch instance running locally (or just use docker compose). ES url is specified by `ES_URL` environment variable (username `ES_USERNAME` and password `ES_PASSWORD` can be random strings in local environment). When you're running elastic for the very first time, you need to create indices and ingest existing data. This can be done by running `python elastic_migrate.py`. This operation is idempotent, so you can always run `python elastic_migrate.py` again to re-ingest all the data. -You can run ElasticSearch separately by using `docker-compose -f docker-compose.yml up -d elastic`. +You can run ElasticSearch separately by using `docker compose -f docker-compose.yml up -d elastic`. ## Image Proxy (optional for local dev) @@ -36,16 +36,18 @@ to a running instance of image proxy along with env var IMAGE_PROXY_SECRET. The same secret env var ought to be passed as config to the running image proxy service. You can also use the docker-compose-dev.yml file to bring up just the image proxy service alone (w/ env var for secret specified in the compose file) -by running: ```docker-compose -f docker-compose-dev.yml up -d imageproxy```. +by running: `docker compose -f docker-compose-dev.yml up -d imageproxy`. When running locally, use the .env.local file to set up the env variables in your environment. - ### Set up the database + Refer the [using locally](../db/README.md#using-locally) section from db README. ### Copy .env.example file to .env file: + cp .env.example .env ### Run the app + yarn dev