Skip to content

docs: add running locally section and supporters.json setup note#8029

Open
imanchalsingh wants to merge 5 commits intowebpack:mainfrom
imanchalsingh:docs/run-locally-supporters-json
Open

docs: add running locally section and supporters.json setup note#8029
imanchalsingh wants to merge 5 commits intowebpack:mainfrom
imanchalsingh:docs/run-locally-supporters-json

Conversation

@imanchalsingh
Copy link

While trying to run the project locally, I ran into a module error
caused by a missing _supporters.json file.

I’ve added a small "Run Locally" section to the contributing docs to
document the setup steps that worked for me, in case it helps future
contributors. Happy to adjust if this should be placed elsewhere.

@vercel
Copy link

vercel bot commented Mar 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
webpack-js-org Ready Ready Preview, Comment Mar 17, 2026 1:15pm

Request Review

@alexander-akait
Copy link
Member

I think we can make it better, adding an empty file and update content during the build

@imanchalsingh
Copy link
Author

I think we can make it better, adding an empty file and update content during the build

Thanks for the suggestion! That makes sense. I’ll update the implementation to create an empty file first and populate the content during the build process instead. Appreciate the guidance.

Copy link
Member

@alexander-akait alexander-akait left a comment

Choose a reason for hiding this comment

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

Just add an empty file, no need to make a script for this and check we are adding content in _supporters.json on the build step

@imanchalsingh
Copy link
Author

Just add an empty file, no need to make a script for this and check we are adding content in _supporters.json on the build step

Actually, the _supporters.json file is ignored by .gitignore, so creating it manually wouldn’t appear for other contributors. That’s why I added a mechanism to auto-generate the file during the build process, ensuring everyone can generate it locally without manual steps.

@alexander-akait
Copy link
Member

In this case add a fallback in resolve in our configuration when files doesn't exist

@imanchalsingh
Copy link
Author

In this case add a fallback in resolve in our configuration when files doesn't exist

Thank you for the suggestion! Adding a fallback makes sense, I’ll take care of it.

@TusharThakur04
Copy link
Contributor

TusharThakur04 commented Mar 17, 2026

@alexander-akait i dont think there is any need for the solution
on running github__token yarn fetch-all, it automatically runs fetch:supporters which in turn fetches all required modules to run the project.
Following the setup guide is all needed.

@alexander-akait
Copy link
Member

@TusharThakur04 We can simplify such things, but maybe you are right, in our guide you need to run this

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.

3 participants