Giter Site home page Giter Site logo

bucket-assets's Introduction

bucket-assets

Uploads a folder of static assets to an s3 bucket with convenient assumptions. These assumptions include:

  • Uploads to a ('/assets/' + truncated git hash) folder for naive fingerprinting and rollback purposes.
  • Adds appropriate s3 headers like setting files to 'public-read' and 'Content-Type'.

Bucket Assets is used in deploys of Artsy apps, but may be useful for you too.

Example

var bucketAssets = require('bucket-assets');
bucketAssets({
  dir: __dirname + 'public/assets',
  key: '<s3-key>', // Defaults to process.env.S3_KEY
  secret: '<s3-secret>', // Defaults to process.env.S3_SECRET
  bucket: 'flare-production',
  callback: function(err) {
    // If no err all assets uploaded to S3 fine!
  }
});

or using the CLI

npm install bucket-assets -g
bucketassets --dir public/assets --secret foo --key bar --bucket flare-production

Contributing

Please fork the project and submit a pull request with tests. Install node modules npm install and run tests with make test.

License

MIT

bucket-assets's People

Contributors

craigspaeth avatar zamiang avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.