Repository navigation
Add a root-level bun run dev command - #88
Piyushrathoree wants to merge 1 commit into
Conversation
|
@jerelvelarde hello , raised a pr with some thing that is mentioned in readme but not actually exists , so I fixed it |
jerelvelarde
left a comment
There was a problem hiding this comment.
Review: security, value, code
Security: no actionable findings. The change adds one script alias to package.json and edits README text. It runs nothing that did not already run. Limits: CI has not run on this fork PR yet (the workflows are waiting for approval), and I did not run the start script.
Value: low as written. I'd change the approach before merging, for three reasons.
-
bun run startalready exists. The rootpackage.jsonon main already has"start": "bash scripts/start.sh"and"stop": "bash scripts/stop.sh", so the README'sbash scripts/start.shcan already be run asbun run start. #87 says the README documents a command that does not exist, but the root README on main does not mentionbun run devanywhere. It documentsbash scripts/start.sh, and that command works. -
devalready means something else inopenbot/. There,bun run devstarts only the app and the API server, andopenbot/docs/development.md:45says to use it "only when you want the app and API server without starting the Docker Bots and computers." With this PR,bun run devat the root would start Postgres, every Bot computer and every service. Someone following the OpenBot docs from the repo root would get the full stack, and someone following this README fromopenbot/would get it without Docker. -
The README would mix two forms of the command. Quick start would say
bun run dev, but the same paragraph still saysbash scripts/stop.sh, and README lines 135 and 165 still saybash scripts/start.sh.
Suggestion: if the goal is a Bun command at the root, document the scripts that already exist, bun run start and bun run stop, and update all four README mentions together without adding dev. That would be a small, clean docs fix.
Summary
devscript that invokes the existing startup command.bun run dev.Closes #87