Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/transloadit/uppy

The next open source file uploader for web browsers :dog:
https://github.com/transloadit/uppy

dropbox encoding file-uploader file-uploads files hacktoberfest instagram javascript mit modular open-source pick-files resumable transloadit tus uploader uppy webbrowser

Last synced: 5 days ago
JSON representation

The next open source file uploader for web browsers :dog:

Host: GitHub
URL: https://github.com/transloadit/uppy
Owner: transloadit
License: mit
Created: 2015-11-16T12:32:33.000Z (about 9 years ago)
Default Branch: main
Last Pushed: 2024-12-09T23:38:02.000Z (12 days ago)
Last Synced: 2024-12-12T09:57:39.146Z (9 days ago)
Topics: dropbox, encoding, file-uploader, file-uploads, files, hacktoberfest, instagram, javascript, mit, modular, open-source, pick-files, resumable, transloadit, tus, uploader, uppy, webbrowser
Language: TypeScript
Homepage: https://uppy.io
Size: 385 MB
Stars: 29,287
Watchers: 324
Forks: 2,012
Open Issues: 161
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

awesome-react-cn - uppy - The next open source file uploader for web browsers (Uncategorized / Uncategorized)
awesome - transloadit/uppy - The next open source file uploader for web browsers :dog: (TypeScript)
awesome - transloadit/uppy - The next open source file uploader for web browsers :dog: (TypeScript)
awesome - uppy - The next open source file uploader for web browsers :dog: (JavaScript)
my-awesome-list - uppy
awesome-react - uppy - The next open source file uploader for web browsers (Uncategorized / Uncategorized)
awesome-web-cn - uppy - 一个文件上传器，支持音频，视频，文件等多种上传方式，支持 node , React ,Vue (Uncategorized / Uncategorized)
awesome - uppy - The next open source file uploader for web browsers (Uncategorized / Uncategorized)
awesome-github-repos - transloadit/uppy - The next open source file uploader for web browsers :dog: (TypeScript)
awesome-learning-resources - uppy - The next open source file uploader for web browsers (Uncategorized / Uncategorized)
awesome-repositories - transloadit/uppy - The next open source file uploader for web browsers :dog: (TypeScript)
awesome-repositories - transloadit/uppy
awesome-github-star - uppy
awesome-naming - uppy - A dog themed uploader component. The name is a blend of _upload_ and _puppy_. It even comes with a crash recovery plugin called _Golden Retriever_. (Tools, Applications, Libraries, Frameworks)
awesome-list - uppy
best-of-react - GitHub - 7% open · ⏱️ 04.06.2024): (File Handling)
StarryDivineSky - transloadit/uppy
awesome-bookmarks - **uppy**
awesome-star-libs - transloadit / uppy
starred-awesome - uppy - The next open source file uploader for web browsers :dog: (JavaScript)
awesome-react - uppy - The next open source file uploader for web browsers ` 📝 6 days ago` (React [🔝](#readme))
awesome-homelab - Uppy
awesome-frontend - uppy - 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. ![](https://img.shields.io/github/stars/transloadit/uppy.svg?style=social&label=Star) (Repository / Form)
stars - uppy
stars - uppy

README

        # [Uppy](https://uppy.io) [![uppy on npm](https://img.shields.io/npm/v/uppy.svg?style=flat-square)](https://www.npmjs.com/package/uppy)



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](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 API to handle any file in your app.

Tests

Deploys

## Example

Code used in the above example:

```js

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)

  .use(ImageEditor)

  .use(Tus, { endpoint: 'https://tusd.tusdemo.net/files/' })

  .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, light 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, Box, Google Drive, Instagram,

  bypassing the user’s device where possible, syncing between servers directly

  via [@uppy/companion](https://uppy.io/docs/companion)

- Works great with file encoding and processing backends, such as

  [Transloadit](https://transloadit.com), works great without (all you need is

  to 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 several 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/core @uppy/dashboard @uppy/tus

```

Add CSS

[uppy.min.css](https://releases.transloadit.com/uppy/v4.8.0/uppy.min.css),

either to your HTML page’s `` or include in JS, if your bundler of choice

supports it.

Alternatively, you can also use a pre-built bundle from Transloadit’s CDN: Smart

CDN. 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.

```html



  import {

    Uppy,

    Dashboard,

    Tus,

  } from 'https://releases.transloadit.com/uppy/v4.8.0/uppy.min.mjs'

  const uppy = new Uppy()

  uppy.use(Dashboard, { target: '#files-drag-drop' })

  uppy.use(Tus, { endpoint: 'https://tusd.tusdemo.net/files/' })

```

## Documentation

- [Uppy](https://uppy.io/docs/uppy/) — full list of options, methods and events

- [Companion](https://uppy.io/docs/companion/) — setting up and running a

  Companion instance, which adds support for Instagram, Dropbox, Box, Google

  Drive and remote URLs

- [React](https://uppy.io/docs/react/) — components to integrate Uppy UI plugins

  with React apps

- [Architecture & Writing a Plugin](https://uppy.io/docs/writing-plugins/) — how

  to write a plugin for Uppy

## Plugins

### UI Elements

- [`Dashboard`](https://uppy.io/docs/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`](https://uppy.io/docs/progress-bar/) — minimal progress bar

  that fills itself when upload progresses

- [`Status Bar`](https://uppy.io/docs/status-bar/) — more detailed progress,

  pause/resume/cancel buttons, percentage, speed, uploaded/total sizes (included

  by default with `Dashboard`)

- [`Informer`](https://uppy.io/docs/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`](https://uppy.io/docs/drag-drop/) — plain drag and drop area

- [`File Input`](https://uppy.io/docs/file-input/) — even plainer “select files”

  button

- [`Webcam`](https://uppy.io/docs/webcam/) — snap and record those selfies 📷

- ⓒ [`Google Drive`](https://uppy.io/docs/google-drive/) — import files from

  Google Drive

- ⓒ [`Dropbox`](https://uppy.io/docs/dropbox/) — import files from Dropbox

- ⓒ [`Box`](https://uppy.io/docs/box/) — import files from Box

- ⓒ [`Instagram`](https://uppy.io/docs/instagram/) — import images and videos

  from Instagram

- ⓒ [`Facebook`](https://uppy.io/docs/facebook/) — import images and videos from

  Facebook

- ⓒ [`OneDrive`](https://uppy.io/docs/onedrive/) — import files from Microsoft

  OneDrive

- ⓒ [`Import From URL`](https://uppy.io/docs/url/) — import direct URLs from

  anywhere on the web

The ⓒ mark means that [`@uppy/companion`](https://uppy.io/docs/companion), a

server-side component, is needed for a plugin to work.

### Destinations

- [`Tus`](https://uppy.io/docs/tus/) — resumable uploads via the open

  [tus](http://tus.io) standard

- [`XHR Upload`](https://uppy.io/docs/xhr-upload/) — regular uploads for any

  backend out there (like Apache, Nginx)

- [`AWS S3`](https://uppy.io/docs/aws-s3/) — plain upload to AWS S3 or

  compatible services

- [`AWS S3 Multipart`](https://uppy.io/docs/aws-s3-multipart/) — S3-style

  “Multipart” upload to AWS or compatible services

### File Processing

- [`Transloadit`](https://uppy.io/docs/transloadit/) — support for

  [Transloadit](http://transloadit.com)’s robust file uploading and encoding

  backend

### Miscellaneous

- [`Golden Retriever`](https://uppy.io/docs/golden-retriever/) — restores files

  after a browser crash, like it’s nothing

- [`Thumbnail Generator`](https://uppy.io/docs/thumbnail-generator/) — generates

  image previews (included by default with `Dashboard`)

- [`Form`](https://uppy.io/docs/form/) — collects metadata from `` right

  before an Uppy upload, then optionally appends results back to the form

- [`Redux`](https://uppy.io/docs/guides/custom-stores#reduxstore) — for your

  emerging [time traveling](https://github.com/gaearon/redux-devtools) needs

## React

- [React](https://uppy.io/docs/react/) — components to integrate Uppy UI plugins

  with React apps

- [React Native](./examples/react-native-expo/) — basic Uppy component for React

  Native with Expo

## Browser Support

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

## FAQ

### Why not 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.

- 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 `` 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 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](https://uppy.io/docs/aws-s3/) 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](https://uppy.io/docs/xhr-upload/#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/companion`](https://uppy.io/docs/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

- Contributor’s guide in [`.github/CONTRIBUTING.md`](.github/CONTRIBUTING.md)

- Changelog to track our release progress (we aim to roll out a release every

  month): [`CHANGELOG.md`](CHANGELOG.md)

## Used by

Uppy is used by: [Photobox](http://photobox.com), [Issuu](https://issuu.com/),

[Law Insider](https://lawinsider.com), [Cool Tabs](https://cool-tabs.com),

[Soundoff](https://soundoff.io), [Scrumi](https://www.scrumi.io/),

[Crive](https://crive.co/) and others.

Use Uppy in your project?

[Let us know](https://github.com/transloadit/uppy/issues/769)!

## Contributors











































































































































## License

The [MIT License](./LICENSE).