uppy/examples/aws-companion
Renée Kooi 7b2283d8ef
examples: add npm run example script
a bad result from adding the examples as dependencies of the root
repository is that they now don't have access to the npm binaries they
need to run in their own folder, because they are installed into the
root repository instead.

this works around that issue.

we may need to consider undoing that change and making the examples work
as standalone projects again, that's easier to understand.

fixes #2024 for now.
2020-01-15 11:16:56 +01:00
..
.gitignore Rename last remnants of uppy-server in examples 2018-08-27 11:26:45 +02:00
index.html More uppy server -> companion renames (#1037) 2018-09-03 14:48:03 +02:00
main.js update docs, tests, and examples with companionUrl rename 2019-04-15 14:56:37 +01:00
package.json lerna link convert (#1730) 2019-07-19 12:16:36 +02:00
readme.md examples: add npm run example script 2020-01-15 11:16:56 +01:00
server.js examples: remove UPPYSERVER_ references 2019-11-20 16:55:30 +01:00

Uppy + AWS S3 Example

This example uses @uppy/companion with a custom AWS S3 configuration. Files are uploaded to a randomly named directory inside the whatever/ directory in a bucket.

Run it

To run this example, make sure you've correctly installed the repository root:

npm install

That will also install the dependencies for this example.

Then, set up the COMPANION_AWS_KEY, COMPANION_AWS_SECRET, COMPANION_AWS_REGION, and COMPANION_AWS_BUCKET environment variables for @uppy/companion.

Then, again in the repository root, start this example by doing:

npm run example aws-companion