starred/karakeep

Fork 0

mirror of https://github.com/karakeep-app/karakeep.git synced 2026-04-25 07:56:05 +03:00

[GH-ISSUE #1290] Improve dev documentation #828

New issue

Open

opened 2026-03-02 11:53:05 +03:00 by kerem · 3 comments

kerem commented

2026-03-02 11:53:05 +03:00

Owner

Originally created by @maelp on GitHub (Apr 21, 2025).
Original GitHub issue: https://github.com/karakeep-app/karakeep/issues/1290

Describe the feature you'd like

Following our discussion on Discord, document that:

we don't need a full pnpm dev in the root, but pnpm web and pnpm workers (for the workers db migration)
and pnpm dev in the browser-extension stuff (also document how to get the browser extension in dev mode in the first place)

perhaps add a setup_dev.sh script which creates a fake .env and all the correct symlinks at the right place

Describe the benefits this would bring to existing Karakeep users

Easier to develop

Can the goal of this request already be achieved via other means?

Reading the doc

Have you searched for an existing open/closed issue?

I have searched for existing issues and none cover my fundamental request

Additional context

No response

Originally created by @maelp on GitHub (Apr 21, 2025). Original GitHub issue: https://github.com/karakeep-app/karakeep/issues/1290 ### Describe the feature you'd like Following our discussion on Discord, document that: - we don't need a full `pnpm dev` in the root, but `pnpm web` and `pnpm workers` (for the workers db migration) - and `pnpm dev` in the browser-extension stuff (also document how to get the browser extension in dev mode in the first place) perhaps add a `setup_dev.sh` script which creates a fake .env and all the correct symlinks at the right place ### Describe the benefits this would bring to existing Karakeep users Easier to develop ### Can the goal of this request already be achieved via other means? Reading the doc ### Have you searched for an existing open/closed issue? - [x] I have searched for existing issues and none cover my fundamental request ### Additional context _No response_

kerem added the

documentation

status/approved

labels

2026-03-02 11:53:05 +03:00

kerem commented

2026-03-02 11:53:05 +03:00

Author

Owner

@maelp commented on GitHub (Apr 21, 2025):

Also:

need to add exposed ports (9222) to the docker-compose.dev for chrome
need to add the BROWSER_WEB_URL=http://localhost:9222 to .env in order to use chrome

@maelp commented on GitHub (Apr 21, 2025): Also: - need to add exposed ports (9222) to the docker-compose.dev for chrome - need to add the `BROWSER_WEB_URL=http://localhost:9222` to .env in order to use chrome

kerem commented

2026-03-02 11:53:05 +03:00

Author

Owner

@maelp commented on GitHub (Apr 21, 2025):

we should document how to set the browser extension in dev mode

do we need to set developer mode in Chrome/Brave etc, and upload first a "pnpm build" version of the plugin(?)
then it seems to be looking at localhost:5174 to hot-reload, but when doing pnpm dev in browser-extension folder, it tries to serve at :5173 so we need to do pnpm dev --port 5174

@maelp commented on GitHub (Apr 21, 2025): we should document how to set the browser extension in dev mode - do we need to set developer mode in Chrome/Brave etc, and upload first a "pnpm build" version of the plugin(?) - then it seems to be looking at localhost:5174 to hot-reload, but when doing pnpm dev in browser-extension folder, it tries to serve at :5173 so we need to do `pnpm dev --port 5174`

kerem commented

2026-03-02 11:53:05 +03:00

Author

Owner

@AdrianAcala commented on GitHub (Apr 22, 2025):

@maelp , I put in this PR. Let me know if there's anything I'm missing.

@AdrianAcala commented on GitHub (Apr 22, 2025): @maelp , I put in this PR. Let me know if there's anything I'm missing.

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/karakeep#828

No description provided.

Rows
Columns