diff options
| author | MohamedBassem <me@mbassem.com> | 2024-02-20 21:23:28 +0000 |
|---|---|---|
| committer | MohamedBassem <me@mbassem.com> | 2024-02-20 21:38:14 +0000 |
| commit | 8711bca9db49546d265fc119b5dcf3eb2db22095 (patch) | |
| tree | 16bf6fd86da06a80014dfb5738e43a63af038793 /README.md | |
| parent | dbdde49c1e4870f402dc8901e0bf78abb790caf9 (diff) | |
| download | karakeep-8711bca9db49546d265fc119b5dcf3eb2db22095.tar.zst | |
docker: Add a docker-based dev environment
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -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. |