cartouche v0.1.2

cartouche

A minimal node.js image service powered by Amazon S3.

Install

npm install cartouche

Quick Overview

###Usage

Just get an Amazon Simple Storage Service instance running and include cartouche in your node application. Note: it might be wise to store your keys as environment variables.

var cartouche = require('cartouche')({
    key: '<AMAZON_S3_API_KEY>',
    secret: '<AMAZON_S3_SECRET>',
    bucket: '<AMAZON_S3_BUCKET>'	
});

It's then super simple to upload a picture.

var photo = cartouche('/path/to/image');

photo.save(function(err, photoData){
	if(!err) console.log(photoData.url.original); 
	// returns the picture's url
});

###Transformations

You can define a set of transformations that will be applied to the picture before it is uploaded.

var photo = cartouche('/path/to/image', {
	resize: {
		width: 800 // will resize the image to have a width of 00px before uploading it
	}
});

photo.save(function(err, photoData){
	if(!err) console.log(photoData.url.original);
	// returns the picture's url	
});

###Versions

You can upload different versions of the same picture. This is extremly useful to generate thumbnails.

var photo = cartouche('/path/to/image', {});

photo.add({
	name: "thumbnail",
	resize: {
		width: 200
	}
});

photo.add({
	name: "thumbnail@2x",
	resize: {
		width: 400
	}
});

photo.save(function(err, photoData){
	if(!err) console.log(photoData.url);
	// returns an object with the urls of the
	// original picture and the two thumbnails
});

Author

• Olivier Lesnicki

License

Licensed under the MIT License.