Skip to content
This repository has been archived by the owner on Feb 23, 2022. It is now read-only.

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wpscholar committed Apr 29, 2020
1 parent 57c94cc commit c914233
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# AWS Lambda - Bluehost Screenshot Service

![Deploy to Lambda](https://github.com/bluehost/lambda-bluehost-screenshot-service/workflows/Deploy%20to%20Lambda/badge.svg)

An AWS Lambda function designed to return a screenshot for a given URL.

## Usage

Visit `https://d7j9v3snm8.execute-api.us-west-2.amazonaws.com/v1?url=:url` where `:url` is an encoded URL.

For example:

```php
https://d7j9v3snm8.execute-api.us-west-2.amazonaws.com/v1?url=https%3A%2F%2Fwww.bluehost.com
```

## Install

- Run `npm install`

## Local Testing

- Run `node local.js`

## Deployment

By default, this repository is setup to auto-deploy when a new commit is made.

However, if you wish to push changes from your local machine while testing, you can simply run the `npm run deploy` command.

In order for local deployments to actually work, you will need to:

- Install the [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) tool.
- Create a [named profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) named `bluehost`.

0 comments on commit c914233

Please sign in to comment.