uppy/examples/companion-custom-provider
Prakash a25226aab2
Fix @uppy/examples (#6099)
we forgot to update the examples after #5830
2025-12-08 09:48:23 +01:00
..
client Fix @uppy/examples (#6099) 2025-12-08 09:48:23 +01:00
server Refactor Companion to ESM (#5803) 2025-07-29 19:07:48 +02:00
index.html Cleanup examples (#5817) 2025-07-10 17:23:58 +02:00
package.json build(deps): bump body-parser from 1.20.3 to 1.20.4 (#6070) 2025-12-02 09:55:11 +01:00
README.md Cleanup examples (#5817) 2025-07-10 17:23:58 +02:00

Uppy + Companion + Custom Provider Example

This example uses @uppy/companion with a dummy custom provider. This serves as an illustration on how integrating custom providers would work

Run it

Note: this example is using fetch, which is only available on Node.js 18+.

First, you want to set up your environment variable. You can copy the content of .env.example and save it in a file named .env. You can modify in there all the information needed for the app to work that should not be committed (Google keys, Unsplash keys, etc.).

[ -f .env ] || cp .env.example .env

To run the example, from the root directory of this repo, run the following commands:

corepack yarn install
corepack yarn build
corepack yarn workspace @uppy-example/custom-provider start