Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Getting Started does not mention node-polyfills for webpack & rollup #4726

Closed
1 task done
imsys opened this issue Jan 23, 2022 · 2 comments
Closed
1 task done
Labels
1.x 1.0 related issues Documentation Relates to project wiki or documentation Stale Has not received enough activity

Comments

@imsys
Copy link

imsys commented Jan 23, 2022

Is there an existing issue for this?

  • I have searched the existing issues

What would you like to say about Web3.js' documentation?

The information is in the github Readme. Okay, I just saw it now but I would expect the ReadTheDocs to be more complete and have it there already.
The docs says to just use npm install web3 and it will be all fine. At least have a link there saying: "to have information on how to make it work on bundles check the github readme"
The first error we get from not knowing this is: browserify/node-util#43 and we all go ask support in their repo.

Anyway, there is also a node-polyfill for Vite, Rollup or SvelteKit that someone has posted a good working example at: blocknative/web3-onboard#762 (comment)

The point is that not everyone could be finding how to make it work with bundlers, I was using it with <script> tags and doing some hackish things to get it working, and already planning to move all my code to ethers so I could integrate it well with a bundler.. but then I found the solution and I think this should be more visible so others doesn't spend so much time on this as well.

Examples/References

No response

@imsys imsys added the Documentation Relates to project wiki or documentation label Jan 23, 2022
@jdevcs
Copy link
Contributor

jdevcs commented Jan 24, 2022

@imsys Thanks for suggestion, could you open PR and suggest changes in documentation.

@jdevcs jdevcs added the 1.x 1.0 related issues label Jan 24, 2022
@github-actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions. If you believe this was a mistake, please comment.

@github-actions github-actions bot added the Stale Has not received enough activity label Mar 26, 2022
@github-actions github-actions bot closed this as completed Apr 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.x 1.0 related issues Documentation Relates to project wiki or documentation Stale Has not received enough activity
Projects
None yet
Development

No branches or pull requests

2 participants