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

Merge pull request #35 from jacksonh-public/patch-1

Browse Source 
Move requirements to the top of the README
This commit is contained in:
Jackson Harper
2022-02-14 12:39:41 +08:00
committed by GitHub
parent 259627a19a 8e3cea5062
commit 70590d7e1c
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -32,6 +32,13 @@ Read more about Omnivore on our blog. <https://blog.omnivore.app/p/getting-start
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 nodejs v14.18
* [Chromium](https://www.chromium.org/chromium-projects/) -- see below for installation info
### Running the web and API services
### 1. Start docker-compose
@ -67,14 +74,6 @@ cp .env.local .env
yarn dev
```
### Requirements for development
Omnivore is written in TypeScript and JavaScript.
* [Node](https://nodejs.org/) -- currently we are using nodejs v14.18
* [Chromium](https://www.chromium.org/chromium-projects/) -- see below for installation info
### Running the puppeteer-parse service outside of Docker
To save pages you need to run the `puppeteer-parse` service.