diff --git a/.eslintrc.js b/.eslintrc.js index 15a8fcf8f..3814d3c9f 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -191,6 +191,7 @@ module.exports = { files: [ '*.mjs', 'e2e/clients/**/*.js', + 'examples/aws-companion/*.js', 'examples/aws-presigned-url/*.js', 'examples/bundled/*.js', 'examples/custom-provider/client/*.js', diff --git a/examples/aws-companion/.gitignore b/examples/aws-companion/.gitignore index 70a19130f..a9a5aecf4 100644 --- a/examples/aws-companion/.gitignore +++ b/examples/aws-companion/.gitignore @@ -1 +1 @@ -uppy.min.css +tmp diff --git a/examples/aws-companion/README.md b/examples/aws-companion/README.md new file mode 100644 index 000000000..be2513a69 --- /dev/null +++ b/examples/aws-companion/README.md @@ -0,0 +1,23 @@ +# 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 + +First, set up the `COMPANION_AWS_KEY`, `COMPANION_AWS_SECRET`, +`COMPANION_AWS_REGION`, and `COMPANION_AWS_BUCKET` environment variables for +`@uppy/companion` in a `.env` file. You may find useful to first copy the +`.env.example` file: + +```sh +[ -f .env ] || cp .env.example .env +``` + +To run this example, from the **repository root**, run: + +```sh +corepack yarn install +corepack yarn workspace @uppy-example/aws-companion start +``` diff --git a/examples/aws-companion/index.html b/examples/aws-companion/index.html index 9ca4cc79c..4af13a3c6 100644 --- a/examples/aws-companion/index.html +++ b/examples/aws-companion/index.html @@ -4,9 +4,8 @@