Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Flexible way to resize and upload images to Amazon S3 or file system storages for Node.js
JavaScript
Tree: de8a6f0d43

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
.gitignore
README.md
index.js
output.html
package.json

README.md

Alleup

Flexible way to resize and upload images to Amazon S3 or file system storages for Node.js. Possible to add different versions of the same file in cropped or resized variant.

Installation

$ npm install alleup

Quick Start

  1. You need to create alleup configuration file with image variants and your storages Example:

    {
        "variants": {
            "resize": {
                "mini" : "300x200",
                "preview": "800x600"
            },
            "crop": {
                "thumb": "200x200"
            }
        },
    
        "storage": {
            "aws": {
                "key" : "AWS_KEY",
                "secret" : "AWS_SECRET",
                "bucket" : "AWS_BUCKET"
            },
            "dir": {
                "path" : "./public/images/" 
            }
        }
    }
    
    2. **Now you can use Alleup**
    
    ```javascript
    var  Alleup = require('alleup');
    var alleup = new Alleup({storage : "aws", config_file: "path_to_alleup_config.json"})
    
    You can use `storage: 'aws'` for store files on Amazon S3 or `storage: 'dir'` for store files in filesystem
  2. Upload example:

    app.post('/upload',  function(req, res) {
      alleup.upload(req, res, function(err, file, res){
    
          console.log("FILE UPLOADED: " + file);
          // THIS YOU CAN SAVE FILE TO DATABASE FOR EXAMPLE
          res.end();
      });
    });
    
    ### Contribution
    **Pull requests are welcome!!!**
    
    ### License
    (The MIT License)
    
    Copyright (c) 2011 Andriy Bazyuta <andriy.bazyuta@gmail.com>
    
    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files (the
    'Software'), to deal in the Software without restriction, including
    without limitation the rights to use, copy, modify, merge, publish,
    distribute, sublicense, and/or sell copies of the Software, and to
    permit persons to whom the Software is furnished to do so, subject to
    the following conditions:
    
    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    
    ---
    ### Author
    Andriy Bazyuta
Something went wrong with that request. Please try again.