# [Uppy](https://uppy.io) Uppy logo: a superman puppy in a pink suit Build Status Uppy is a sleek, modular JavaScript file uploader that integrates seamlessly with any application. It’s fast, easy to use and lets you worry about more important problems than building a file uploader. - **Fetch** files from local disk, remote urls, Google Drive, Dropbox, 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](https://uppy.io/docs)** | **[Try Uppy](https://uppy.io/examples/dashboard/)** Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service. ## Example Uppy UI Demo: modal dialog with a few selected files and an upload button Code used in the above example: ```js const Uppy = require('uppy/lib/core') const Dashboard = require('uppy/lib/plugins/Dashboard') const GoogleDrive = require('uppy/lib/plugins/GoogleDrive') const Instagram = require('uppy/lib/plugins/Instagram') const Webcam = require('uppy/lib/plugins/Webcam') const Tus = require('uppy/lib/plugins/Tus') const uppy = Uppy({ autoProceed: false }) .use(Dashboard, { trigger: '#select-files' }) .use(GoogleDrive, { target: Dashboard, host: 'https://server.uppy.io' }) .use(Instagram, { target: Dashboard, host: 'https://server.uppy.io' }) .use(Webcam, { target: Dashboard }) .use(Tus, { endpoint: 'https://master.tus.io/files/' }) .run() .on('complete', (result) => { console.log('Upload result:', result) }) ``` **[Try it online](https://uppy.io/examples/dashboard/)** or **[read the docs](https://uppy.io/docs)** for more details on how to use Uppy and its plugins. ## Features - Lightweight, modular plugin-based architecture, easy on dependencies :zap: - Resumable file uploads via the open [tus](https://tus.io/) standard, so large uploads survive network hiccups - Supports picking files from: Webcam, Dropbox, Google Drive, Instagram, bypassing the user’s device where possible, syncing between servers directly via [uppy-server](https://github.com/transloadit/uppy-server) - Works great with file encoding and processing backends, such as [Transloadit](https://transloadit.com), works great without (just roll your own Apache/Nginx/Node/FFmpeg/etc backend) - Sleek user interface :sparkles: - Optional file recovery (after a browser crash) with [Golden Retriever](https://uppy.io/docs/golden-retriever/) - Speaks multiple languages (i18n) :earth_africa: - Built with accessibility in mind - Free for the world, forever (as in beer 🍺, pizza 🍕, and liberty 🗽) - Cute as a puppy, also accepts cat pictures :dog: ## Installation ``` bash $ npm install uppy --save ``` We recommend installing from npm and then using a module bundler such as [Webpack](http://webpack.github.io/), [Browserify](http://browserify.org/) or [Rollup.js](http://rollupjs.org/). Add CSS [uppy.min.css](https://transloadit.edgly.net/releases/uppy/v0.23.3/dist/uppy.min.css), either to `` of your HTML page or include in JS, if your bundler of choice supports it — transforms and plugins are available for Browserify and Webpack. 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 currently 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 just a few. 1\. Add a script to the bottom of ``: ``` html ``` 2\. Add CSS to ``: ``` html ``` 3\. Initialize: ``` html
``` ## Documentation - [Uppy](https://uppy.io/docs/uppy/) — full list of options, methods, and events. - [Plugins](https://uppy.io/docs/plugins/) — list of Uppy plugins and their options. - [Server](https://uppy.io/docs/server/) — setting up and running an Uppy Server instance, which adds support for Instagram, Dropbox, Google Drive and other remote sources. - [React](https://uppy.io/docs/react/) — components to integrate Uppy UI plugins with React apps. - Architecture & Making a Plugin — how to write a plugin for Uppy [documentation in progress]. ## Plugins - `Tus` — resumable uploads via the open [tus](http://tus.io) standard - `XHRUpload` — regular uploads for any backend out there (like Apache, Nginx) - `Transloadit` — support for [Transloadit](http://transloadit.com)’s robust file uploading and encoding backend - `AwsS3` — upload to AWS S3 (also works for Google Cloud) - `Dashboard` — universal UI with previews, progress bars, metadata editor and all the cool stuff - `DragDrop` — plain and simple drag and drop area - `FileInput` — even plainer “select files” button - `ProgressBar` — minimal progress bar that fills itself when upload progresses - `StatusBar` — 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`) - `GoldenRetriever` — restores files after a browser crash, like it’s nothing - `ThumbnailGenerator` — generates image previews (included by default with `Dashboard`) - `Form` — collects metadata from `
` right before an Uppy upload, then optionally appends results back to the form - `ReduxDevTools` — for your emerging [time traveling](https://github.com/gaearon/redux-devtools) needs - `GoogleDrive`, `Dropbox`, `Instagram`, `Url` — select files from [Google Drive](https://www.google.com/drive/), [Dropbox](https://www.dropbox.com/), [Instagram](https://www.instagram.com/) and direct urls from anywhere on the web. Note that[`uppy-server`](https://github.com/transloadit/uppy-server) is needed for these. - `Webcam` — snap and record those selfies 📷 ## Browser Support Sauce Test Status We aim to support IE10+ and recent versions of Safari, Edge, Chrome, Firefox, and Opera. ## FAQ ### Why not just use ``? 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](https://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 (and e.g. cropping is planned). - 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 just 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 & 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 of these features. A `` 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](https://tus.io) and [Uppy](https://uppy.io),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](https://transloadit.com). Our thinking is that if just 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 just yet :D ### Does Uppy support React? Yep, we have Uppy React components, please see [Uppy React docs](https://uppy.io/docs/react/). ### Does Uppy support S3 uploads? Yes, there is an S3 plugin, please check out the [docs](https://uppy.io/docs/aws-s3/) for more. ### Do I need to install special service/server for Uppy? Can I use it with Rails/Node/Go/PHP? Yes, whatever you want on the backend will work with `XHRUpload` plugin, since it just does a `POST` or `PUT` request. Here’s a [PHP backend example](https://uppy.io/docs/xhrupload/#Uploading-to-a-PHP-Server). If you want resumability with the Tus plugin, use [one of the tus server implementations](https://tus.io/implementations.html) 👌🏼 And you’ll need [`uppy-server`](https://github.com/transloadit/uppy-server) 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 - Contributor’s guide in [`website/src/docs/contributing.md`](website/src/docs/contributing.md) - Changelog to track our release progress (we aim to roll out a release every month): [`CHANGELOG.md`](CHANGELOG.md) ## License [The MIT License](LICENSE).