https://github.com/paulogdm/s3-example

Simple example using micro for uploading stuff to AWS S3.
https://github.com/paulogdm/s3-example

example micro microservice microservices now s3

Last synced: 19 days ago
JSON representation

Simple example using micro for uploading stuff to AWS S3.

• Host: GitHub
• URL: https://github.com/paulogdm/s3-example
• Owner: paulogdm
• Created: 2018-03-15T14:21:00.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-01-10T21:35:53.000Z (almost 6 years ago)
• Last Synced: 2024-12-10T14:59:24.081Z (about 1 month ago)
• Topics: example, micro, microservice, microservices, now, s3
• Language: JavaScript
• Homepage:
• Size: 44.9 KB
• Stars: 46
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Serverless S3 example

Simple example using Now 2.0, Zeit's micro and the AWS SDK to upload files to the cloud.

[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)

[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/paulogdm/s3-example)

## How to use

### Getting Started

Clone this [repo](https://github.com/paulogdm/s3-example):

Edit `config.js`:

```javascript

// ...

  BUCKET_NAME: isNOW ? process.env.BUCKET_NAME : 'micro-s3-example',

  ACCESS_KEY: isNOW ? process.env.ACCESS_KEY : 'ACCESSKEY',

  SECRET_KEY: isNOW ? process.env.SECRET_KEY : 'SECRETKEY',

  REGION: isNOW ? process.env.REGION : 'us-west-1'

// ...

```

If you are running this example locally, you should edit the fields on the right. If you are planning to test it on [now.sh](https://now.sh) you need to add [secrets](https://zeit.co/docs/v2/deployments/environment-variables-and-secrets/). Please refer to the section "[deploying to now.sh](https://github.com/paulogdm/s3-example#deploying-to-nowsh)".

### Deploying to `now.sh`

First install `now`:

```bash

npm install -g now

```

Second you need to add a few `now` [secrets](https://zeit.co/docs/getting-started/secrets):

```bash

now secrets add bucket_name "micro-s3-example"

now secrets add access_key "ACCESSKEY"

now secrets add secret_key "SECRETKEY"

now secrets add region "us-west-1"

```

*PS: The key of those secrets will always be lower case (E.g: `BUCKET_NAME` will be `process.env.bucket_name`)*

Deploy it to the cloud with [now](https://zeit.co/now):

```bash

now

```

Check the script "deploy" inside "package.json".

### Rest Clients

You can also see this example in action with [Insomnia](https://insomnia.rest/) importing the requests from [insomnia.json](insomnia.json).

## Packages Used In This Example

 * [micro](https://github.com/zeit/micro)

 * [AWS SDK](https://github.com/aws/aws-sdk-js)

## Author

[@paulogdm](https://github.com/paulogdm)

## License

MIT