odysseyscience/react-s3-uploader

Document support for using with react-dropzone

Open

#43 opened on Nov 17, 2015

View on GitHub
 (10 comments) (0 reactions) (0 assignees)JavaScript (828 stars) (243 forks)batch import
enhancementhelp wanted

Description

I've personally integrated this with react-dropzone, but the code was too specific to my use case to release.

We should add some code and documentation for the preferred way to integrate with react-dropzone.

For those wondering, I essentially bypassed the ReactS3Uploader react component and just included s3upload.js directly. Using the S3Upload class, I just wrapped each dropped file in a new instance, which kicks off the same upload process as using the component.

Contributor guide

Tech stack
javascriptreact
Domain
frontenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactJavaScriptreact dropzone
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the existing `s3upload.js` file and the `ReactS3Uploader` component to understand the current upload mechanism. Examine the react dropzone library API. Create a code example that wraps each dropped file in a new `S3Upload` instance, as suggested in the issue. Add documentation to the README explaining the integration approach. Also check the 10 comments on the issue for additional user insights or code snippets.