OpenBMB / OpenBMB/PilotDeck

feat(windows): automatic configuration generation for npm start and npm server

Open Beginner friendly
#36 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
4k
Forks
453
Avg merge
12h 30m
Merged PRs (30d)
46

Description

Description

Currently, the .pilotdeck directory and related configuration files are only generated by the predev hook when running npm run dev.

If users launch the app with npm run start or npm run server inside the ui directory, the bootstrap-pilotdeck-config.mjs script will not execute. This causes startup failures on Windows due to missing directories and config files.

Proposed Solution

  1. Add prestart and preserver hooks in ui/package.json to run the bootstrap script before executing corresponding commands.
  2. (Optional but recommended) Add auto-bootstrap logic in entry files like load-env.js as a fallback. It guarantees environment initialization no matter which startup command is used.

Additional Context

This issue is closely related to the Windows compatibility fix in #28. Automating the configuration process will greatly reduce the onboarding difficulty for new Windows users.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with ui/package.json and the bootstrap-pilotdeck-config.mjs script to see how the existing predev hook initializes configuration. Check load-env.js for the optional fallback, then verify that npm start and npm server execute the bootstrap before startup, including on Windows.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
developer-experience
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.