Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.5 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.5 KB

Vercel Serverless Backend for S3 or Github

Save data to S3 or Github straight from your front-end app using Vercel functions!

This project provides a unified api to communicate with any S3-compatible storage (e.g. Amazon S3, Digitalocean Spaces, Linode Object Storage, etc) or a Github repo. It currently uses Firebase Auth for authentication but can easily be adapted to your preferred auth system

How To

  1. Clone this repo and deploy to Vercel
  2. Set the following environment variables in Vercel:

For use with S3-compatible storage:

S3_ENDPOINT: the endpoint of your S3-compatible storage (e.g. eu-central-1.linodeobjects.com)
S3_BUCKET: your bucket
S3_KEY: your S3 key
S3_SECRET: your S3 secret

For use with a Github repo

GH_OWNER: Github username
GH_REPO: Github repo
GH_TOKEN: Github token

  1. Set the Firebase config in public/js/firebase.js to match your Firebase account
  2. Visit index.html to check out the demos

Api

Saving Data

To save data from your front-end app, just call:

setData(service, path, type, content)

service: either 's3' or 'github', depending on which backend storage you want to use
path: path to the file you want to save, e.g. data.json or myimage.jpg
type: type of data, e.g. json or img
content: the data

Fetching data

To fetch data, just call:

getData(service, path)

service: either 's3' or 'github', depending on which backend storage you want to use
path: path to the file you want to save, e.g. data.json or myimage.jpg\