Skip to content

Commit

Permalink
Update README.md (#8)
Browse files Browse the repository at this point in the history
Add missing parts for deployment process

- s3sync requires AWS credentials to be set as environmental variables
- jq is required external library
  • Loading branch information
artoliukkonen authored and sbstjn committed Feb 27, 2018
1 parent c3ac381 commit 19cd49f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,18 @@ The S3 Bucket configuration is only needed for the included example website and

*Amazon requires unique names for S3 buckets and other resources. Please rename at least the service before you try to deploy the example!*


## Deployment

`s3sync` requires you to set AWS access keys as environmental variables.

```bash
AWS_ACCESS_KEY=abc123
AWS_SECRET_KEY=def456
```

Deploy script uses [jq](https://stedolan.github.io/jq/) to read variables from generated output during deployment process. If you don't have jq installed, [download it here](https://stedolan.github.io/jq/download/).

Running `yarn deploy` will trigger a [serverless](https://serverless.com) deployment. After the output of your CloudFormation Stack is available, the included static websites will be generated *(using the hostname from the stack output)* and uploaded to the configured S3 buckets. As the last step, the deploy process will display the URLs of the example website and dashboard:

```bash
Expand Down

0 comments on commit 19cd49f

Please sign in to comment.