uppy/examples/companion-custom-provider
2026-06-30 16:50:59 +05:30
..
client lint fix 2026-06-30 16:50:59 +05:30
server Refactor Companion to ESM (#5803) 2025-07-29 19:07:48 +02:00
index.html @uppy: upgrade biome and more improvements (#6244) 2026-05-21 12:28:03 +08:00
package.json refactor(core): merge @uppy/provider-views into core via ./provider-views export 2026-06-22 01:40:32 +05:30
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