From 8711bca9db49546d265fc119b5dcf3eb2db22095 Mon Sep 17 00:00:00 2001 From: MohamedBassem Date: Tue, 20 Feb 2024 21:23:28 +0000 Subject: docker: Add a docker-based dev environment --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 4a33cb9e..a32fa90f 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,15 @@ I'm a systems engineer in my day job (and have been for the past 7 years). I did ## Development +### Docker + +You can turnup the whole development environment with: +`docker compose -f docker/docker-compose.dev.yml up` + +### Manual + +Or if you have nodejs installed locally, you can do: + - `yarn install` in the root of the repo. - `yarn prisma:migrate:dev` then `yarn prisma:generate` to generate prisma's data and run the database migrations. - `yarn web` to start the web app. @@ -75,3 +84,7 @@ I'm a systems engineer in my day job (and have been for the past 7 years). I did - `packages/shared`: Shared utilities and code between the workers and the web app. - `packages/web`: Where the nextjs based web app lives. - `packages/workers`: Where the background job workers (crawler and openai as of now) run. + +### Submitting PRs + +- Before submitting PRs, you'll want to run `yarn format` and include its changes in the commit. Also make sure `yarn lint` is successful. -- cgit v1.2.3-70-g09d2