# alleup > Flexible way to resize and upload images to Amazon S3 or file system storages Latest version **0.1.1** (published 2012-08-08) · 0 weekly downloads ## Install ```sh npm install alleup pnpm add alleup yarn add alleup bun add alleup ``` ## Health **Score 10/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; low quality score; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.1 | | Published | 2012-08-08 | | First published | 2011-11-28 | | Weekly downloads | 0 | | TypeScript types | none | | Module format | CommonJS | | Node | >= 0.4.1 <= 0.8.6 | | Dependencies | 3 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 93 | | Author | Andriy Bazuta | | Maintainers | andriy | | Keywords | upload, image, imagemagick, amazon, aws, s3, resize, file | ## Links - npm: https://www.npmjs.com/package/alleup - Repository: https://github.com/tih-ra/alleup - npm.io page: https://npm.io/package/alleup ## Dependencies (3) - [knox](https://npm.io/package/knox.md) ~0.0.9 - [formidable](https://npm.io/package/formidable.md) ~1.0.7 - [imagemagick](https://npm.io/package/imagemagick.md) ~0.1.2 ## Alternatives - [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads - [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads - [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads - [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads - [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads ## Recent versions - 0.1.1 (latest) — 2012-08-08 - 0.1.0 — 2011-12-25 - 0.0.5 — 2011-12-03 - 0.0.3 — 2011-12-02 - 0.0.2 — 2011-11-28 - 0.0.1 — 2011-11-28 ## README 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: ```javascript { "variants": { "resize": { "mini" : "300x200", "preview": "800x600" }, "crop": { "thumb": "200x200" } }, "storage": { "aws": { "key" : "AWS_KEY", "secret" : "AWS_SECRET", "bucket" : "AWS_BUCKET" }, "dir": { "path" : "./public/images/" } } } Example config with scopes (only from version 0.1.0): { "variants": { "projects": { //projects is scope "resize": { "mini" : "300x200", "preview": "800x600" }, "crop": { "thumb": "200x200" } }, "gallery": { //gallery is scope "crop": { "thumb": "100x100" } } }, "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 ## UPLOAD, URL and DELETE 1. **Upload example:** ```javascript app.get('/upload_form', function(req, res) { res.writeHead(200, {'content-type': 'text/html'}); res.end( '' ); }); app.post('/upload', function(req, res) { // Without Scopes alleup.upload(req, res, function(err, file, res){ console.log("FILE UPLOADED: " + file); // THIS YOU CAN SAVE FILE TO DATABASE FOR EXAMPLE res.end(); }); //With Scope `projects` (look at example of configuration file) alleup.upload(req, res, function(err, file, res){ console.log("FILE UPLOADED: " + file); // THIS YOU CAN SAVE FILE TO DATABASE FOR EXAMPLE res.end(); }, 'projects'); }); 2. **Remove uploaded file example:** ```javascript // Without Scopes app.get('/delete', function(req, res) { alleup.remove('1322506647.jpg', function(err) { // THIS YOU CAN DELETE FILE FROM DATABASE FOR EXAMPLE res.end(); }); // With Scope `projects` (look at example of configuration file) app.get('/delete', function(req, res) { alleup.remove('1322506647.jpg', function(err) { // THIS YOU CAN DELETE FILE FROM DATABASE FOR EXAMPLE res.end(); }, 'projects'); }); 3. **Get file url example:** ```javascript alleup.url(file, variant); `file` - The name of the file you uploaded, saved for example in database (`345621345.jpg`), `variant` - one of your image variants names from alleup_congig.json ### 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 --- _Source: https://npm.io/package/alleup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._