Code Monkey home page Code Monkey logo

uppy's Introduction

Uppy logo: a smiling puppy above a pink upwards arrow

Uppy is a sleek, modular JavaScript file uploader that integrates seamlessly with any application. It’s fast, has a comprehensible API and lets you worry about more important problems than building a file uploader.

  • Fetch files from local disk, remote URLs, Google Drive, Dropbox, Box, Instagram or snap and record selfies with a camera
  • Preview and edit metadata with a nice interface
  • Upload to the final destination, optionally process/encode

Read the docs | Try Uppy

Uppy is being developed by the folks at Transloadit, a versatile API to handle any file in your app.

TestsCI status for Uppy testsCI status for Companion testsCI status for browser tests
DeploysCI status for CDN deploymentCI status for Companion deploymentCI status for website deployment

Example

Code used in the above example:

import Uppy from '@uppy/core'
import Dashboard from '@uppy/dashboard'
import RemoteSources from '@uppy/remote-sources'
import ImageEditor from '@uppy/image-editor'
import Webcam from '@uppy/webcam'
import Tus from '@uppy/tus'

const uppy = new Uppy()
  .use(Dashboard, { trigger: '#select-files' })
  .use(RemoteSources, { companionUrl: 'https://companion.uppy.io' })
  .use(Webcam, { target: Dashboard })
  .use(ImageEditor, { target: Dashboard })
  .use(Tus, { endpoint: 'https://tusd.tusdemo.net/files/' })
  .on('complete', (result) => {
    console.log('Upload result:', result)
  })

Try it online or read the docs for more details on how to use Uppy and its plugins.

Features

  • Lightweight, modular plugin-based architecture, light on dependencies ⚡
  • Resumable file uploads via the open tus standard, so large uploads survive network hiccups
  • Supports picking files from: Webcam, Dropbox, Box, Google Drive, Instagram, bypassing the user’s device where possible, syncing between servers directly via @uppy/companion
  • Works great with file encoding and processing backends, such as Transloadit, works great without (all you need is to roll your own Apache/Nginx/Node/FFmpeg/etc backend)
  • Sleek user interface ✨
  • Optional file recovery (after a browser crash) with Golden Retriever
  • Speaks several languages (i18n) 🌍
  • Built with accessibility in mind
  • Free for the world, forever (as in beer 🍺, pizza 🍕, and liberty 🗽)
  • Cute as a puppy, also accepts cat pictures 🐶

Installation

npm install @uppy/core @uppy/dashboard @uppy/tus

Add CSS uppy.min.css, either to your HTML page’s <head> or include in JS, if your bundler of choice supports it.

Alternatively, you can also use a pre-built bundle from Transloadit’s CDN: Edgly. In that case Uppy will attach itself to the global window.Uppy object.

⚠️ The bundle consists of most Uppy plugins, so this method is not recommended for production, as your users will have to download all plugins when you are likely using only a few.

<!-- 1. Add CSS to `<head>` -->
<link href="https://releases.transloadit.com/uppy/v3.24.3/uppy.min.css" rel="stylesheet">

<!-- 2. Initialize -->
<div id="files-drag-drop"></div>
<script type="module">
  import { Uppy, Dashboard, Tus } from "https://releases.transloadit.com/uppy/v3.24.3/uppy.min.mjs"

  const uppy = new Uppy()
  uppy.use(Dashboard, { target: '#files-drag-drop' })
  uppy.use(Tus, { endpoint: 'https://tusd.tusdemo.net/files/' })
</script>

Documentation

  • Uppy — full list of options, methods and events
  • Plugins — list of Uppy plugins and their options
  • Companion — setting up and running a Companion instance, which adds support for Instagram, Dropbox, Box, Google Drive and remote URLs
  • React — components to integrate Uppy UI plugins with React apps
  • Architecture & Writing a Plugin — how to write a plugin for Uppy

Plugins

List of plugins and their common options

UI Elements

  • Dashboard — universal UI with previews, progress bars, metadata editor and all the cool stuff. Required for most UI plugins like Webcam and Instagram
  • Progress Bar — minimal progress bar that fills itself when upload progresses
  • Status Bar — more detailed progress, pause/resume/cancel buttons, percentage, speed, uploaded/total sizes (included by default with Dashboard)
  • Informer — send notifications like “smile” before taking a selfie or “upload failed” when all is lost (also included by default with Dashboard)

Sources

  • Drag & Drop — plain drag and drop area
  • File Input — even plainer “select files” button
  • Webcam — snap and record those selfies 📷
  • Google Drive — import files from Google Drive
  • Dropbox — import files from Dropbox
  • Box — import files from Box
  • Instagram — import images and videos from Instagram
  • Facebook — import images and videos from Facebook
  • OneDrive — import files from Microsoft OneDrive
  • Import From URL — import direct URLs from anywhere on the web

The ⓒ mark means that @uppy/companion, a server-side component, is needed for a plugin to work.

Destinations

  • Tus — resumable uploads via the open tus standard
  • XHR Upload — regular uploads for any backend out there (like Apache, Nginx)
  • AWS S3 — plain upload to AWS S3 or compatible services
  • AWS S3 Multipart — S3-style “Multipart” upload to AWS or compatible services

File Processing

Miscellaneous

  • Golden Retriever — restores files after a browser crash, like it’s nothing
  • Thumbnail Generator — generates image previews (included by default with Dashboard)
  • Form — collects metadata from <form> right before an Uppy upload, then optionally appends results back to the form
  • Redux — for your emerging time traveling needs

React

  • React — components to integrate Uppy UI plugins with React apps
  • React Native — basic Uppy component for React Native with Expo

Browser Support

We aim to support recent versions of Chrome, Firefox, Safari and Edge.

We still provide a bundle which should work on IE11, but we are not running tests on it.

Polyfills

Here’s a list of polyfills you’ll need to include to make Uppy work in older browsers, such as IE11:

If you’re using a bundler, you need to import them before Uppy:

import 'core-js'
import 'whatwg-fetch'
import 'abortcontroller-polyfill/dist/polyfill-patch-fetch'
// Order matters: AbortController needs fetch which needs Promise (provided by core-js).

import 'md-gum-polyfill'
import ResizeObserver from 'resize-observer-polyfill'

window.ResizeObserver ??= ResizeObserver

export { default } from '@uppy/core'
export * from '@uppy/core'

If you’re using Uppy from CDN, those polyfills are already included in the legacy bundle, so no need to include anything additionally:

<script src="https://releases.transloadit.com/uppy/v3.24.3/uppy.legacy.min.js"></script>

FAQ

Why not use <input type="file">?

Having no JavaScript beats having a lot of it, so that’s a fair question! Running an uploading & encoding business for ten years though we found that in cases, the file input leaves some to be desired:

  • We received complaints about broken uploads and found that resumable uploads are important, especially for big files and to be inclusive towards people on poorer connections (we also launched tus.io to attack that problem). Uppy uploads can survive network outages and browser crashes or accidental navigate-aways.
  • Uppy supports editing meta information before uploading.
  • Uppy allows cropping images before uploading.
  • There’s the situation where people are using their mobile devices and want to upload on the go, but they have their picture on Instagram, files in Dropbox or a plain file URL from anywhere on the open web. Uppy allows to pick files from those and push it to the destination without downloading it to your mobile device first.
  • Accurate upload progress reporting is an issue on many platforms.
  • Some file validation — size, type, number of files — can be done on the client with Uppy.
  • Uppy integrates webcam support, in case your users want to upload a picture/video/audio that does not exist yet :)
  • A larger drag and drop surface can be pleasant to work with. Some people also like that you can control the styling, language, etc.
  • Uppy is aware of encoding backends. Often after an upload, the server needs to rotate, detect faces, optimize for iPad, or what have you. Uppy can track progress of this and report back to the user in different ways.
  • Sometimes you might want your uploads to happen while you continue to interact on the same single page.

Not all apps need all these features. An <input type="file"> is fine in many situations. But these were a few things that our customers hit / asked about enough to spark us to develop Uppy.

Why is all this goodness free?

Transloadit’s team is small and we have a shared ambition to make a living from open source. By giving away projects like tus.io and Uppy, we’re hoping to advance the state of the art, make life a tiny little bit better for everyone and in doing so have rewarding jobs and get some eyes on our commercial service: a content ingestion & processing platform.

Our thinking is that if only a fraction of our open source userbase can see the appeal of hosted versions straight from the source, that could already be enough to sustain our work. So far this is working out! We’re able to dedicate 80% of our time to open source and haven’t gone bankrupt yet. :D

Does Uppy support S3 uploads?

Yes, please check out the docs for more information.

Can I use Uppy with Rails/Node.js/Go/PHP?

Yes, whatever you want on the backend will work with @uppy/xhr-upload plugin, since it only does a POST or PUT request. Here’s a PHP backend example.

If you want resumability with the Tus plugin, use one of the tus server implementations 👌🏼

And you’ll need @uppy/companion if you’d like your users to be able to pick files from Instagram, Google Drive, Dropbox or via direct URLs (with more services coming).

Contributions are welcome

Used by

Uppy is used by: Photobox, Issuu, Law Insider, Cool Tabs, Soundoff, Scrumi, Crive and others.

Use Uppy in your project? Let us know!

Contributors

arturi goto-bus-stop kvz aduh95 ifedapoolarewaju hedgerh
arturi goto-bus-stop kvz aduh95 ifedapoolarewaju hedgerh
Murderlon AJvanLoon nqst mifi github-actions[bot] lakesare
Murderlon AJvanLoon nqst mifi github-actions[bot] lakesare
dependabot[bot] kiloreux samuelayo sadovnychyi richardwillars ajkachnic
dependabot[bot] kiloreux samuelayo sadovnychyi richardwillars ajkachnic
zcallan YukeshShr janko oliverpool Botz mcallistertyler
zcallan YukeshShr janko oliverpool Botz mcallistertyler
mokutsu-coursera dschmidt DJWassink mrbatista taoqf timodwhit
mokutsu-coursera dschmidt DJWassink mrbatista taoqf timodwhit
tim-kos eltociear tuoxiansp pauln MikeKovarik toadkicker
tim-kos eltociear tuoxiansp pauln MikeKovarik toadkicker
ap-- tranvansang LiviaMedeiros bertho-zero juliangruber Hawxy
ap-- tranvansang LiviaMedeiros bertho-zero juliangruber Hawxy
gavboulton mejiaej elenalape dominiceden Acconut jhen0409
gavboulton mejiaej elenalape dominiceden Acconut jhen0409
stephentuso bencergazda a-kriya yonahforst suchoproduction sksavant
stephentuso bencergazda a-kriya yonahforst suchoproduction sksavant
ogtfaber nndevstudio MatthiasKunnen manuelkiessling dargmuesli johnnyperkins
ogtfaber nndevstudio MatthiasKunnen manuelkiessling dargmuesli johnnyperkins
ofhope yaegor zhuangya sparanoid ThomasG77 subha1206
ofhope yaegor zhuangya sparanoid ThomasG77 subha1206
schonert SlavikTraktor scottbessler jrschumacher rosenfeld rdimartino
schonert SlavikTraktor scottbessler jrschumacher rosenfeld rdimartino
richmeij Youssef1313 allenfantasy Zyclotrop-j anark bdirito
richmeij Youssef1313 allenfantasy Zyclotrop-j anark bdirito
darthf1 fortrieb heocoi jarey muhammadInam rettgerst
darthf1 fortrieb heocoi jarey muhammadInam rettgerst
mkabatek jukakoski olemoign ahmedkandel btrice 5idereal
mkabatek jukakoski olemoign ahmedkandel btrice 5idereal
AndrwM behnammodi BePo65 bradedelman camiloforero command-tab
AndrwM behnammodi BePo65 bradedelman camiloforero command-tab
craig-jennings davekiss denysdesign ethanwillis richartkeil paescuj
craig-jennings davekiss denysdesign ethanwillis richartkeil paescuj
msand martiuslim Martin005 mskelton mactavishz lafe
msand martiuslim Martin005 mskelton mactavishz lafe
dogrocker jedwood jasonbosco frobinsonj ghasrfakhri geertclerx
dogrocker jedwood jasonbosco frobinsonj ghasrfakhri geertclerx
neuronet77 rossng scherroman robwilson1 SxDx refo
neuronet77 rossng scherroman robwilson1 SxDx refo
raulibanez luarmr eman8519 Pzoco ppadmavilasom phillipalexander
raulibanez luarmr eman8519 Pzoco ppadmavilasom phillipalexander
pmusaraj pedrofs plneto patricklindsay pascalwengerter Tashows
pmusaraj pedrofs plneto patricklindsay pascalwengerter Tashows
taj strayer sjauld steverob amaitu quigebo
taj strayer sjauld steverob amaitu quigebo
waptik SpazzMarticus szh sergei-zelinsky sebasegovia01 sdebacker
waptik SpazzMarticus szh sergei-zelinsky sebasegovia01 sdebacker
samuelcolburn fortunto2 GNURub rart ken-kuro mkopinsky
samuelcolburn fortunto2 GNURub rart ken-kuro mkopinsky
mhulet hrsh mauricioribeiro matthewhartstonge mjesuele mattfik
mhulet hrsh mauricioribeiro matthewhartstonge mjesuele mattfik
mateuscruz masumulu28 masaok martin-brennan marcusforsberg marcosthejew
mateuscruz masumulu28 masaok martin-brennan marcusforsberg marcosthejew
mperrando onhate marc-mabe ParsaArvanehPA cryptic022 Ozodbek1405
mperrando onhate marc-mabe ParsaArvanehPA cryptic022 Ozodbek1405
leftdevel nil1511 coreprocess nicojones trungcva10a6tn naveed-ahmad
leftdevel nil1511 coreprocess nicojones trungcva10a6tn naveed-ahmad
pleasespammelater marton-laszlo-attila navruzm mogzol shahimclt mnafees
pleasespammelater marton-laszlo-attila navruzm mogzol shahimclt mnafees
boudra achmiral mosi-kha maddy-jo mdxiaohu magumbo
boudra achmiral mosi-kha maddy-jo mdxiaohu magumbo
jx-zyf kode-ninja sontixyou jur-ng johnmanjiro13 jyoungblood
jx-zyf kode-ninja sontixyou jur-ng johnmanjiro13 jyoungblood
green-mike gaelicwinter frederikhors franckl fingul elliotsayes
green-mike gaelicwinter frederikhors franckl fingul elliotsayes
YehudaKremer JimmyLv zanzlender olitomas yoann-hellopret vedran555
YehudaKremer JimmyLv zanzlender olitomas yoann-hellopret vedran555
tusharjkhunt thanhthot stduhpf slawexxx44 rtaieb rmoura-92
tusharjkhunt thanhthot stduhpf slawexxx44 rtaieb rmoura-92
rlebosse rhymes luntta phil714 ordago odselsevier
rlebosse rhymes luntta phil714 ordago odselsevier
ninesalt xhocquet willycamargo weston-sankey-mark43 dwnste nagyv
ninesalt xhocquet willycamargo weston-sankey-mark43 dwnste nagyv
stiig valentinoli vially trivikr top-master tvaliasek
stiig valentinoli vially trivikr top-master tvaliasek
tomekp tomsaleeba WIStudent tmaier twarlop tcgj
tomekp tomsaleeba WIStudent tmaier twarlop tcgj
dzcpy dkisic craigcbrunner codehero7386 christianwengert cgoinglove
dzcpy dkisic craigcbrunner codehero7386 christianwengert cgoinglove
canvasbh c0b41 avalla arggh alfatv agreene-coursera
canvasbh c0b41 avalla arggh alfatv agreene-coursera
aduh95-test-account sartoshi-foot-dao zackbloom zlawson-ut zachconner yafkari
aduh95-test-account sartoshi-foot-dao zackbloom zlawson-ut zachconner yafkari
Cruaier sercraig ardeois CommanderRoot czj cbush06
Cruaier sercraig ardeois CommanderRoot czj cbush06
Aarbel cfra csprance prattcmp subvertallchris charlybillaud
Aarbel cfra csprance prattcmp subvertallchris charlybillaud
Cretezy chao cellvinchung cartfisk cyu radarhere
Cretezy chao cellvinchung cartfisk cyu radarhere
kergekacsa eliOcs yoldar efbautista emuell EdgarSantiago93
kergekacsa eliOcs yoldar efbautista emuell EdgarSantiago93
sweetro jeetiss DennisKofflard hoangsvit davilima6 akizor
sweetro jeetiss DennisKofflard hoangsvit davilima6 akizor
KaminskiDaniell Cantabar mrboomer danilat danschalow danmichaelo
KaminskiDaniell Cantabar mrboomer danilat danschalow danmichaelo
functino amitport tekacs Dogfalo aalepis alexnj
functino amitport tekacs Dogfalo aalepis alexnj
asmt3 ahmadissa adritasharma Adrrei adityapatadia adamvigneault
asmt3 ahmadissa adritasharma Adrrei adityapatadia adamvigneault
ajh-sr adamdottv abannach superhawk610 ajschmidt8 bryanjswift
ajh-sr adamdottv abannach superhawk610 ajschmidt8 bryanjswift
bedgerotto wbaaron Quorafind bducharme azizk azeemba
bedgerotto wbaaron Quorafind bducharme azizk azeemba
ayhankesicioglu atsawin ash-jc-allen apuyou arthurdenner Abourass
ayhankesicioglu atsawin ash-jc-allen apuyou arthurdenner Abourass
tyndria anthony0030 andychongyz andrii-bodnar superandrew213 firesharkstudios
tyndria anthony0030 andychongyz andrii-bodnar superandrew213 firesharkstudios
kaspermeinema tykarol jvelten mellow-fellow jmontoyaa jcalonso
kaspermeinema tykarol jvelten mellow-fellow jmontoyaa jcalonso
jbelej jszobody jorgeepc jondewoo jonathanarbely jsanchez034
jbelej jszobody jorgeepc jondewoo jonathanarbely jsanchez034
Jokcy chromacoma profsmallpine IanVS Lucklj521 lucax88x
Jokcy chromacoma profsmallpine IanVS Lucklj521 lucax88x
lucaperret ombr louim dolphinigle leomelzer leods92
lucaperret ombr louim dolphinigle leomelzer leods92
galli-leo dviry larowlan leaanthony hoangbits labohkip81
galli-leo dviry larowlan leaanthony hoangbits labohkip81
kyleparisi elkebab kidonng kevin-west-10x huydod HussainAlkhalifah
kyleparisi elkebab kidonng kevin-west-10x huydod HussainAlkhalifah
HughbertD hiromi2424 giacomocerquone roenschg gjungb geoffappleford
HughbertD hiromi2424 giacomocerquone roenschg gjungb geoffappleford
gabiganam fuadscodes dtrucs ferdiusa fgallinari Gkleinereva
gabiganam fuadscodes dtrucs ferdiusa fgallinari Gkleinereva
epexa EnricoSottile elliotdickison theJoeBiz Jmales jessica-coursera
epexa EnricoSottile elliotdickison theJoeBiz Jmales jessica-coursera
vith janwilts janklimo jamestiotio jcjmcclean Jbithell
vith janwilts janklimo jamestiotio jcjmcclean Jbithell
JakubHaladej jakemcallister gaejabong JacobMGEvans mazoruss GreenJimmy
JakubHaladej jakemcallister gaejabong JacobMGEvans mazoruss GreenJimmy
intenzive NaxYo ishendyweb
intenzive NaxYo ishendyweb

Software

We use Browserstack for manual testing BrowserStack logo

License

The MIT License.

uppy's People

Contributors

aduh95 avatar ajkachnic avatar ajvanloon avatar arturi avatar botz avatar dependabot[bot] avatar djwassink avatar dschmidt avatar github-actions[bot] avatar goto-bus-stop avatar hedgerh avatar ifedapoolarewaju avatar janko avatar kiloreux avatar kvz avatar lakesare avatar mcallistertyler avatar mifi avatar mokutsu-coursera avatar mrbatista avatar murderlon avatar nqst avatar oliverpool avatar richardwillars avatar sadovnychyi avatar samuelayo avatar taoqf avatar timodwhit avatar yukeshshr avatar zcallan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

uppy's Issues

design: Progressbar/spinner/etc

Many operations will take time. Sometimes we can't estimate accurately how much. We need to have a UI component that all plugins can use, that signals to the user we're happily processing their data.

I think this could be one of the 'utilities' exposed by 'core'?

CSS Framework

It would be cool if the sandbox looked a bit prettier. It would also be cool if our css adhers to some standard.

What are your opinions on using / compatibility with:

  • bootstrap
  • foundation
  • skeleton
  • something else?

Make some plugin’s settings & methods available globally

6b10341#diff-a5d451cf6049b41234206c1ad2a59f94R6 — to add action attribute to a form, I need to know where the form will submit its data. In this case only Tus plugin knows about that, since it’s the uploader.

Could be solved via the separate form data plugin? If not, let's forget about form data in this plugin for now and make it work via files only.

I wanted to make sure forms can be submitted even when JavaScript is disabled / not yet loaded. But now that I think about it, we handle the markup with JS already. Is it a right thing to do? Slow connections exist, if we add <form> markup by hand it’s not that pretty for developers, but better for semantics and users.

procedure to handle uploads with same name

If not already implemented a procedure to handle uploads with same name is need.
This may occur
by uploads

  • from different users e.g. very common things like "christmas-2015.mp4"
  • from same user e.g. when he/she uploads an image and after that he noticed something is wrong with it, corrects the problem and uploaded it again (without changing file name)

Modals by default?

I think for simple file uploading - we may not want to default to using modals.

Look at this example of someone integrating with Transloadit with minimal impact / blocking UI:

https://github.com/pamelafox/bootstrap-transloadit-plugin <-- it has a link to an example, but the bootstrap layout is broken. normally you'd see a progress bar right on the page

visual feedback on "uploading progress"

Feedback on things going on is always important.

When uploading a file at least these points are interesting:

  • how long will it take until complete (most important)
  • how big is the file in total I'm uploading (important, if you're paying for mobile data or have a limit per month)
  • how big is the part already uploaded (interesting/motivating)
  • how fast is it loading (only interesting)

some ideas on implementing progress bars in an efficient way:
https://css-tricks.com/html5-progress-element/

meta: Staging server

Deploys all branches somewhere on every push, so we have a central place to look at and discuss.

plugin: Basic preset

As discussed in #19 and #9 and in Slack, we finally agreed on the following structure: https://github.com/transloadit/transloadit-js-client/blob/f1aa1072d5159c372624a57d5a8edaad2119efa9/classes.es6#L71

Meaning: TransloaditBasic is a plugin - that applies a convenient set of other plugins so novices won't have to do much wiring together to get basic jquery-sdk-like (#6) functionality.

Ideas for functionality:

  • tus 1.0 uploading to Transloadit (you can use master.tus.io:8080 for testing)
  • drag & drop enabled
  • modal by default
  • progress bar(s) enabled

give the user the feeling of control over his data -and possibility to also have it

The user uploads his own, maybe private data.
So they have to trust the website and the things going on there during upload procedure.

For giving them this feeling he need the information

  • what is going on - see #62
  • are the right things going on / done by them - see #61

and in addition
they need to have the feeling -and for this the possibility to control the things going on.
every time.

This could be achieved by

  • giving/showing a possibility to cancel the upload during the uploading process
  • giving/showing a possibility to delete uploaded files (of not already processed further e.g because of waiting for other uploads)
  • giving/showing a possibility to delete files chosen but not uploaded yet (if this is possible in uploading procedure)

Pause/resume uploads

There are some circumstances a button/possibility to manually pause a large, long time running upload and resume it afterwards would be really helpful:

  1. total upload bandwidth is limited and one need it for other things
  2. one is leaving office/home and change the network (WIFI->3G) and had to pay for traffic/has limited traffic per month
  3. a combination of 1) and 2): one is leaving office/home and change the network (WIFI->3G) and the upload bandwidth is smaller but one need t for other things
  4. other uploads have higher prio and should use it's bandwidth
  5. as a possibility to communicate that an upload is able to be resumed
    (to the user who does not know that this is possible)
  6. ...

don't know exactly if this kind of button/possibility may be also interesting for other "not from local" uploads (for other reasons)

please release often and constantly update demo

Would be very handy at this state of project if one would release new minor versions very often (e.g roughly once per week or every 25 commits) and keep demo up to date to latest released version.

With this one could easily comment on new things happen and report ideas/issues.

If needed because v1.0 is coming to fast, one could ad a digit in numbering -> x.xx.x ;-)

at this time there are 47 commits to master

2016-03-14_14h44_16

=> what do you think?

visual feedback on choosing & uploading "the right file"

It's always nice to have some visual feedback, if one is doing right (choosing right file)

Of course a preview of a file after upload is nice,
but it's more important to have a confirmation for doing right as early as possible in upload process.

This could done by showing

  • file name
  • file type
  • file size (this also helps to have a feeling needed upload time...)

To enhance visualisation of filetye and have a good fitting, nice looking "symbol" for a file during (from very first start) and after successful upload
maybe one can make it easy to use font awesome icons for this.

e.g.

zip, rar,... https://fortawesome.github.io/Font-Awesome/icon/file-archive-o/

mp4,mov,... https://fortawesome.github.io/Font-Awesome/icon/film/

mp3, wav,... https://fortawesome.github.io/Font-Awesome/icon/file-audio-o/

photos, images,... https://fortawesome.github.io/Font-Awesome/icon/file-image-o/

pdf https://fortawesome.github.io/Font-Awesome/icon/file-pdf-o/

txt https://fortawesome.github.io/Font-Awesome/icon/file-text-o/

php, html,... https://fortawesome.github.io/Font-Awesome/icon/file-code-o/

excel https://fortawesome.github.io/Font-Awesome/icon/file-excel-o/
word https://fortawesome.github.io/Font-Awesome/icon/file-word-o/
powerpoint https://fortawesome.github.io/Font-Awesome/icon/file-powerpoint-o/

Restructure sandbox

The 'surroundings' (html etc) could be in ./examples/X. It should use a transpiled version of the project. .travis.yml needs to upload both so we can easily review online as well as locally.

Fast iterations are paramount here. No manual steps

uppy modal not opening today

hmm I'm sure I did opened it in different browsers yesterday.
When I wanted to look in more details in it today, it doesn't open any more (FF,IE,Opera)
2016-03-09_11h41_53

plugins: plugin system

Currently, the client is going to use a pluggable architecture that allows integration from third party APIs like so:

transloadit
  .use(dropbox)
  .use(googleDrive)

There are two major use cases for the transloadit client:

  1. Upload files to Transloadit with the help of the transloadit client UI
  2. Upload files to Transloadit with a custom UI

What will the transloadit plugins need to provide in both of these cases?

It seems the process can be abstracted as follows:

input file -> modifications/configuration -> uploading -> server-side processing -> output

Render examples with Hexo fully?

Currently, Hexo will take sass/css, html, etc files from ./website/src, transpiles, and injects them into ./website/public.

Then we have a watch-examples.js file, that takes ./website/src/examples/*/src/js/*.js, transpiles, and injects them into ./website/src/examples/*/static/js/*.js.

I just found this hexo plugin: https://github.com/townewgokgok/hexo-renderer-babel/blob/master/index.js

It would allow us to use es6 code inside ./website/src/examples/*/js/*.es6 which would then be transpiled into ./website/public/examples/*/js/*.js. This way we could:

  • only keep '1 tab open' as hexo could do all the watching and transpiling of example code(?),
  • remove ./website/src/examples/*/static/ folders
  • have building in line with how we're already handling the other assets (html/sass and even markdown/ejs I suppose).

My proposal would be trying to see if we can let hexo take care of babel, instead of a custom local script for examples.

If needed I could try to get this to work myself, seeing as how @arturi is focussing other website improvements and @hedgerh on the server component now.

+1 / -1 ?

plugin: Instagram

Forked from #9 - Create an example Instagram plugin (doesn't have to work well, just for the structure).

Make sure acceptance testsuite fails

For instance, this should have been caught by the test:

I would propose making a branch that deliberately tries to make Travis unhappy - until it does. Then remove the failure and merge the test plumbing back into master

possibility to restrict upload

possibility to restrict upload form same client in an easy way

for

  • usability (make user know what is expected),
  • load handling and
  • security reasons

possible restrictions:

  • allowed filetypes (whitelist)
  • max number of file size (each) - if already know at start of upload
  • max number of files simultaneously

and maybe also

  • max number of files within a defined period (e.g. 10 per hour)
  • parts of filename: blacklisted words and unwanted characters like " ", "ü"...
    (not that user-friendly but sometimes necessary because of system restrictions...)
  • min number of file size (each)
    e.g. for first instance image quality check (no one wants to print a 1kb jpeg) and of course for security (no upload of tiny scripts is need)

give always a message why upload is not working anymore

Transform Plugins: crop, rotate, resize

I'm thinking a bit about how the processing/transform plugins are going to need to work. The following API (just an example) is not going to suffice:

Uppy
  .use(DragDrop, { target: 'foo' })
  .use(UppyResize)
  .use(UppyRotate)
  .use(UppyCrop)

Given that transforms need to run in a very specific order, I think the best approach is to turn processing plugins into functions, rather than classes, unless there is some reason we actually need classes in the instance, which I don't think we do. We can then provide the developer with the following API:

Uppy.apply(resize(800,600))

Where .apply(), or whatever we want to call it, chains together all of the transform functions in the order in which they are provided.

If our file uploader has a photo editor that allows the user to make changes to an image before uploading, the transforms need to be ran in a very specific order to get the desired processed image.

Consider the following image:

rickmorty

If I run:

Uppy.apply(resize(800, 600))
.apply(rotate(90))

I get:

rickmorty1

If I run:

Uppy.apply(rotate(90))
.apply(resize(800,600))

I get:

rickmorty2

This is also the best approach to the API because some transforms will need to be applied more than once, like if you resize, crop, rotate, then resize an image.

Improve website

Subtodos:

  • Improve layout on Mobile (#37)
  • Get it in line with our Contributors Guide (sass)
  • Get comfortable changing any aspect
  • Screenshot sounds great
  • Improve homepage content (also the feature/icons)
  • Fix Guide content (remove pages that aren't about Uppy)
  • A generator for API docs too (research what exists already)
  • Pick a nice new font
  • Pick some nice new colors (we might revise with M ilan but that's easy to change (see $primary color in .styl files for instance)
  • Slap new logos on top (we'll wait on M ilan for this)

Modal upload: no single sign of d&d file visible

Of course it's a very early stage, but at this time in modal upload there is no single sign of a file visible.
After drag&drop a file everything still looks the same as if there is no file.
But upload seem to work :-)

plugin: Drag & drop

Maybe have a look at dropzone - many of their users have coincidentally asked for Transloadit integration already

Build System

I found out that we can use a --standalone Transloadit flag with browserify to easily create a UMD module. That means our transloadit-js-client.js dist file would be used globally like so:

<script src="transloadit-js-client.js"></script>
<script>
  var transloadit = new Transloadit();
  transloadit
    .use(Transloadit.InstagramPlugin)
    .use(Transloadit.DragDropPlugin)

  // or
  transloadit
    .use(Transloadit.TransloaditBasic)
</script>

Keep in mind this is only if someone downloads the distributable file, rather than using the lib build through npm. The lib build is simply a transpiled version of all of the core / plugins files. Will be pushing a PR soon, but wanted to open this up for any discussion regarding the build system so everyone was on the same page.

Formdata

Discussion began here: 6b10341#commitcomment-15725322

Should Formdata object be available in every selector plugin like DragDrop and passed to uploaders which might use it or not, or should we use some Formdata-forming function in plugins like Multipart that actually need it?

global and per instance settings

for things like "possibility to restrict upload" #69 (and many others)
it would be great to have a possibility
to define these things global per website and per each uploader instance visible on the site

Sometimes there maybe even be 2-3 uploader instances on a single url
where each need different settings...

Applying plugins when DOM elements aren't static

Consider the following scenario:
http://hedgerh.github.io/fileupload-demo/

A template is generated on the fly when the user selects which option they want to use. For the case of the drag n drop plugin, it needs a target element to designate the drop area, but that target does not exist statically on the page.

So if we used something like:

Transloadit
  .use(dragdrop, { target: 'dragarea' })
  .use(instagram)
  .use(dropbox)

it's not going to work. We'll need to apply the drag drop plugin to the element every time it regenerates.

Thoughts?

Repo link:
http://github.com/hedgerh/fileupload-demo

Browsersync?

What is everyone's thoughts about browser sync? It will be useful when we need to check our CSS in multiple browsers/devices. I went ahead and added it to the project in my PR, but if anyone feels strongly against it we can switch back. 🐙

PR: #16

i18n support

It would be cool if the community could add support for additional languages beyond English easily.

How to best approach this with the plugin-based architecture is an unanswered question. Maybe we can research how do other similar projects do it? (I'm suspecting Vue.js may have support for Chinese for instance 😄)

plugin: Dropbox

Made some interesting progress on the Dropbox plugin.

Flow

So here is the flow that I have in mind for the plugin to be used. oAuth authentication is still a question mark.

  1. User calls uppy.use(DropboxPlugin)
  2. User calls DropboxPlugin.connect('#target', optionalCustomRenderFunction) to start the plugin on a target DOM element.
  3. If enduser is auth'd, fetch their Dropbox root '/' directory. If not, do oAuth.
  4. On successful fetch of root directory, pass the result array to a built-in render method or a custom render function provided by the user to display folders/files.
  5. Add event listeners for fetching a directory's contents or for selecting a file to upload.
  6. On file select, plugin call DropboxPlugin.addFile method to add file to list of files to upload internally.
  7. User calls uppy.start()
  8. Uppy calls on a method like DropboxPlugin.getUploadInstructions() to get the necessary interface for being able to fetch the file.

To get a file from Dropbox, you make a GET request to content.dropboxapi.com to a /files endpoint, so somehow we're going to need to have the upload target server make that request.

procedures to optimize problematic filenames

Some type of names of uploaded files may potentially break something.

For these filenames a procedure is need to optimize problematic file names
(if not wanted to be caught by possibility to restrict upload #69)

At least two cases:

  • containing characters that may break something (depending on systems used...)
    (like " " or "ü" or one of these ! * ' ( ) ; : @ & = + $ , / ? % # [ ])
  • having a length that may break something e.g. longer than 255 characters

for ideas see
https://stackoverflow.com/questions/146134/how-to-remove-illegal-characters-from-path-and-filenames

this should work hand in hand with #71

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.