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

Move requirements to the top of the README

Browse Source 
This makes it easier for people to find the correct node.js version.
This commit is contained in:
jacksonh-public
2022-02-13 08:47:22 -08:00
committed by GitHub
parent f7e3a1657e
commit 8e3cea5062
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. 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 ### Running the web and API services
### 1. Start docker-compose ### 1. Start docker-compose
@ -67,14 +74,6 @@ cp .env.local .env
yarn dev 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 ### Running the puppeteer-parse service outside of Docker
To save pages you need to run the `puppeteer-parse` service. To save pages you need to run the `puppeteer-parse` service.