Benature/omnivore
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update the README with new docker-compose instructions

Browse Source
This commit is contained in:
Jackson Harper
2022-02-12 13:16:55 -08:00
parent 46b526961a
commit 80a3d67cbd
1 changed files with 2 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -30,13 +30,10 @@ Read more about Omnivore on our blog. <https://blog.omnivore.app/p/getting-start
## How to setup local development ## How to setup local development
The easiest way to get started with local development is to use `docker-compose up`. This will start a postgres container, our web frontend, and an API server. 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.
Along with docker-compose you will need to run our `puppeteer-parse` service. This service is used to
fetch web page content and relies on puppeteer and chromium which currently do not run inside of
docker.
### Requirements ### Requirements for development
* [Node](https://nodejs.org/) -- currently we are using nodejs v14.18 * [Node](https://nodejs.org/) -- currently we are using nodejs v14.18
* [Chromium](https://www.chromium.org/chromium-projects/) -- see below for installation info * [Chromium](https://www.chromium.org/chromium-projects/) -- see below for installation info