diff --git a/README.md b/README.md index fe1f54db9..511c421c2 100644 --- a/README.md +++ b/README.md @@ -32,12 +32,6 @@ Read more about Omnivore on our blog. 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. diff --git a/packages/web/.env.local b/packages/web/.env.local new file mode 100644 index 000000000..7e54a65f8 --- /dev/null +++ b/packages/web/.env.local @@ -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" +