Skip to content

Commit

Permalink
chore: remove docs for build tooling polyfill setup
Browse files Browse the repository at this point in the history
Revert "chore: remove docs for build tooling polyfill setup"

This reverts commit 6cf6694.

chore: remove docs for build tooling polyfill setup
  • Loading branch information
DanielSinclair committed May 22, 2024
1 parent bfc39d9 commit e0ce589
Showing 1 changed file with 0 additions and 10 deletions.
10 changes: 0 additions & 10 deletions site/data/en-US/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,16 +114,6 @@ RainbowKit will now handle your user's wallet selection, display wallet/transact

Some build tools will require additional setup.

##### React, Next.js, and Webpack

The [Webpack v5](https://webpack.js.org/blog/2020-10-10-webpack-5-release/) bundler used by Next.js and Create React App [no longer provides Node polyfills](https://webpack.js.org/blog/2020-10-10-webpack-5-release/#automatic-nodejs-polyfills-removed), so you'll need to include these modules yourself to satisfy RainbowKit's peer dependencies. Create React App specifically requires that you polyfill `Buffer`.

Reference our [Next.js Webpack Config](https://github.com/rainbow-me/rainbowkit/blob/main/examples/with-next/next.config.js), [Next.js App Router Webpack Config](https://github.com/rainbow-me/rainbowkit/blob/main/examples/with-next-app/next.config.js), and [Create React App polyfills](https://github.com/rainbow-me/rainbowkit/blob/main/examples/with-create-react-app/src/polyfills.ts) samples for configuration guidance for your project.

##### Vite

The [Vite](https://vitejs.dev) bundler doesn't provide Node polyfills, so you'll need to include polyfills for `global`, `Buffer` and `process.env`. As an example, you can reference the [polyfills in our sample Vite project](https://github.com/rainbow-me/rainbowkit/tree/main/examples/with-vite/src/polyfills.ts).

##### Remix

When using [Remix](https://remix.run), you must polyfill `buffer`, `events` and `http` modules. Reference the Remix configuration below, or [our sample Remix project](https://github.com/rainbow-me/rainbowkit/blob/main/examples/with-remix).
Expand Down

0 comments on commit e0ce589

Please sign in to comment.