Skip to content

Add a root-level bun run dev command - #88

Open
Piyushrathoree wants to merge 1 commit into
CopilotKit:mainfrom
Piyushrathoree:add-root-dev-script
Open

Piyushrathoree wants to merge 1 commit into
CopilotKit:mainfrom
Piyushrathoree:add-root-dev-script

Conversation

@Piyushrathoree

Copy link
Copy Markdown

Summary

  • Add a root dev script that invokes the existing startup command.
  • Update Quick start to use bun run dev.

Closes #87

@Piyushrathoree

Copy link
Copy Markdown
Author

@jerelvelarde hello , raised a pr with some thing that is mentioned in readme but not actually exists , so I fixed it

@jerelvelarde jerelvelarde left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

  1. bun run start already exists. The root package.json on main already has "start": "bash scripts/start.sh" and "stop": "bash scripts/stop.sh", so the README's bash scripts/start.sh can already be run as bun run start. #87 says the README documents a command that does not exist, but the root README on main does not mention bun run dev anywhere. It documents bash scripts/start.sh, and that command works.

  2. dev already means something else in openbot/. There, bun run dev starts only the app and the API server, and openbot/docs/development.md:45 says to use it "only when you want the app and API server without starting the Docker Bots and computers." With this PR, bun run dev at 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 from openbot/ would get it without Docker.

  3. The README would mix two forms of the command. Quick start would say bun run dev, but the same paragraph still says bash scripts/stop.sh, and README lines 135 and 165 still say bash 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a root-level bun run dev command

2 participants