Napoleon's Pixelated Mugshot
    Wondering what’s next for npm?Check out our public roadmap! »

    This package has been deprecated

    Author message:

    Uppy Server has been replaced by Uppy Companion https://www.npmjs.com/package/@uppy/companion. Please switch, as this package is no longer supported.

    uppy-server
    TypeScript icon, indicating that this package has built-in type declarations

    0.13.4 • Public • Published

    uppy-server

    Uppy logo — a superman puppy in a pink suit

    Build Status

    Uppy-server is a server integration for Uppy file uploader.

    It handles the server-to-server communication between your server and file storage providers such as Google Drive, Dropbox, Instagram, etc. See here for full documentation

    Install

    npm install uppy-server

    Usage

    Uppy-server may either be used as pluggable express app, which you plug to your already existing server, or it may simply be run as a standalone server:

    Plug to already existing server

     
    var express = require('express')
    var bodyParser = require('body-parser')
    var session = require('express-session')
    var uppy = require('uppy-server')
     
    var app = express()
    app.use(bodyParser.json())
    app.use(session({secret: 'some secrety secret'}))
    ...
    // be sure to place this anywhere after app.use(bodyParser.json()) and app.use(session({...})
    const options = {
      providerOptions: {
        google: {
          key: 'GOOGLE_KEY',
          secret: 'GOOGLE_SECRET'
        }
      },
      server: {
        host: 'localhost:3020',
        protocol: 'http',
      },
      filePath: '/path/to/folder/'
    }
     
    app.use(uppy.app(options))
     

    To enable uppy socket for realtime feed to the client while upload is going on, you call the socket method like so.

    ...
    var server = app.listen(PORT)
     
    uppy.socket(server, options)
     

    Run as standalone server

    Please ensure that the required env variables are set before runnning/using uppy-server as a standalone server. See.

    $ uppy-server

    If you cloned the repo from gtihub and want to run it as a standalone server, you may also run the following command from within its directory

    npm start

    Run as a serverless function

    Uppy-server can be deployed as a serverless function to AWS Lambda or other cloud providers through serverless. Check this guide to get started.

    After you have cloned the repo go inside examples/serverless:

    cd examples/serverless
    

    You can enter your API Keys inside the serverless.yml file:

    INSTAGRAM_KEY: <YOUR_INSTAGRAM_KEY>
    INSTAGRAM_SECRET: <YOUR_INSTAGRAM_SECRET>
    

    When you are all set install the dependencies and deploy your function:

    npm install && sls deploy
    

    See full documentation

    Install

    npm i uppy-server

    DownloadsWeekly Downloads

    20

    Version

    0.13.4

    License

    ISC

    Unpacked Size

    105 kB

    Total Files

    44

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar