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

Add a section on using docker-compose to run the backend for frontend engineers

Browse Source
This commit is contained in:
Jackson Harper
2022-02-12 13:40:05 -08:00
parent c3774a0f22
commit e776342d6f
2 changed files with 27 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -32,12 +32,6 @@ 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
* [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
@ -60,7 +54,28 @@ option.
Go to <http://localhost:3000/email-registration> in your browser.
### Running the puppeteer-parse service
### Frontend Development
If you want to work on just the frontend of Omnivore you can run the backend services
with docker compose and the frontend locally:
```bash
docker-compose up api content-fetch
cd packages/web
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.

5
packages/web/.env.local Normal file
View File

@ -0,0 +1,5 @@
NEXT_PUBLIC_APP_ENV=local
NEXT_PUBLIC_LOCAL_BASE_URL="http://localhost:3000"
NEXT_PUBLIC_LOCAL_SERVER_BASE_URL="http://localhost:4000"
NEXT_PUBLIC_LOCAL_HIGHLIGHTS_BASE_URL="http://localhost:4000"