Skip to content

Commit 581777b

Browse files
committed
adds README
1 parent 4bf546a commit 581777b

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Lambda PHP Skeleton
2+
3+
Skeleton to kick off projects using AWS Lambda functions with PHP. Because AWS Lambda does not natively support PHP, the Bref Framework is used which provides a layer to execute PHP code on AWS Lambda.
4+
5+
## Getting Started
6+
7+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
8+
9+
### Prerequisites
10+
11+
#### AWS credentials
12+
13+
* Create AWS keys: https://bref.sh/docs/installation/aws-keys.html
14+
* Store AWS key and secret in env vars. You may include them in your `.bash_profile` / `.zshrc`:
15+
```
16+
export AWS_ACCESS_KEY_ID=YOUR_AWS_KEY
17+
export AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET
18+
export AWS_DEFAULT_REGION=eu-central-1
19+
```
20+
21+
#### Local serverless installation
22+
Most commands run in docker images. The bref console commands can not be executed in docker though, but must be executed locally. To use these commands, PHP >=7.2 and serverless must be installed.
23+
24+
See installation instructions for serverless: https://bref.sh/docs/installation.html#serverless
25+
26+
## Running the tests
27+
28+
TODO: Explain how to run the automated tests for this system
29+
30+
## Deployment
31+
32+
Deployment to AWS can be done by executing
33+
34+
```
35+
make serverless-deploy
36+
```

0 commit comments

Comments
 (0)