aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMohamedBassem <me@mbassem.com>2024-02-26 16:32:14 +0000
committerMohamedBassem <me@mbassem.com>2024-02-26 16:50:00 +0000
commit4ffa87aa07a66397881d4d5ad0f97c66c61e6878 (patch)
tree419612b3ce4bd2dbb06b69eb83c1e77652d2061a /README.md
parent3fe20dda157cbae282f55d6afb8e8f99e795945a (diff)
downloadkarakeep-4ffa87aa07a66397881d4d5ad0f97c66c61e6878.tar.zst
build: Migrate from yarn to pnpm
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index b7aad09e..1a0b5cdd 100644
--- a/README.md
+++ b/README.md
@@ -88,11 +88,11 @@ You can turnup the whole development environment with:
Or if you have nodejs installed locally, you can do:
-- `yarn install` in the root of the repo.
-- `yarn db:migrate` to run the db migrations.
-- `yarn web` to start the web app.
+- `pnpm install` in the root of the repo.
+- `pnpm db:migrate` to run the db migrations.
+- `pnpm web` to start the web app.
- Access it over `http://localhost:3000`.
-- `yarn workers` to start the crawler and the openai worker.
+- `pnpm workers` to start the crawler and the openai worker.
- You'll need to have redis running at `localhost:5379` (configurable with env variables).
- An easy way to get redis running is by using docker `docker run -p 5379:5379 redis`.
- You can run the web app without the workers, but link fetching and automatic tagging won't work.
@@ -106,4 +106,4 @@ Or if you have nodejs installed locally, you can do:
### 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.
+- Before submitting PRs, you'll want to run `pnpm format` and include its changes in the commit. Also make sure `pnpm lint` is successful.