Table of Contents

1. BucketWS demo
2. Video
3. Getting Started
   • Prerequisites
   • Installation
   • Setup
   • Start
4. Optimized images
5. About
6. Contact

BucketWS demo

This is a demo nodejs server that uses the BucketWS service for the next functionalities:

• Upload files signed from the server to a public bucket
• Upload files signed from the server to a private bucket
• Authorize the viewer to see the private bucket files
• List the files from the public bucket
• List the files from the private bucket
• Upload a file anonymously

Video

The next video have a couple of details that are not up to date, if you have any issue please review the latest documentation: https://www.bucketws.com/docs/bucket/docs/getting-started-node Check this 2min video that shows the process of create the buckets on the UI and go through the demo functionalities. view video

Getting Started

You can test the API on your localhost and start uploading file in 5 minutes.

Prerequisites

• Create an account at https://app.bucketws.com/auth/app/register
• Create a public bucket named test-public
• Get the API Key

Installation

• Clone this repository

  git clone https://github.com/vicjicaman/bucketws-demo.git
  

• Go to the cloned repository and install the packages

  yarn install
  

Setup

• Create a file .env on the repository folder with the next content, replace the values with your bucket names and account domain and secrets.

    DOMAIN=xxxxxx.pws-trial-uc1.xyz
    BUCKET_PUBLIC=test-public
    API_KEY=kkkkkkkk-kkkk-kkkk-kkkk-kkkkkkkkkkkk

Start

• Start the service, by default you will find the service running on http://localhost:3000

  yarn start
  

Optimized images

If you upload a png, webp or jpg file the service generated a set of smaller resized images that you can use depending on the target viewport, this smaller size image is a minimap

You can include on your site the next script to automatically detect and change the right image based on the image or background width.

    <script src="https://xxxxxx.pws-trial-uc1.xyz/package/uploader-lib/latest/index.js"></script>

Now use the image URL on the src attribute as in this example:

    <img 
    src="https://util-files.listws.com/_PWSR_/files/minimaps/buckets/photos/9aca4aa83e79507630361b8fad6a7561.jpg"
    /> 

You can resize your screen or check the image on any device, the image will be automatically changed to get the optimal image size.

About

BucketWS is a service to let you create private or public file buckets that will be delivered over a CDN with SSL

Contact

Victor Jimenez - @vicjicama - [email protected] Website: Bucket

(back to top)