Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 75248d9

Browse files
📝 add Development section to README
1 parent 244cc34 commit 75248d9

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

‎README.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,43 @@ $ terraform destroy
122122

123123
**NOTICE: the above command probably ends up with error. See [Deleting Lambda@Edge Functions and Replicas](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-edge-delete-replicas.html) for detail.**
124124

125+
## Development
126+
127+
You just need to install [Docker](https://www.docker.com/) to develop this module.
128+
129+
- Terraform configurations for this module is located at [module/](module/) directory.
130+
- Lambda@Edge function source code is located at [src/basic-auth.js](src/basic-auth.js). It needs to be transpiled by [Babel](https://babeljs.io/) and minified by [UglifyJS](http://lisperator.net/uglifyjs/) before zip-compressed by Terraform.
131+
132+
### Updating Lambda Function Code
133+
134+
If you update the Lambda function source code, you also need to update the function code in the module. It can be done by running:
135+
136+
```bash
137+
$ ./build.sh
138+
```
139+
140+
### Deleting Generated Lambda Function Code
141+
142+
If you want to delete Lambda function code generated by running `./build.sh`, run the following:
143+
144+
```bash
145+
$ ./clean.sh
146+
```
147+
148+
You should rarely have to use the command.
149+
150+
### Generating Inputs and Outputs Documentation
151+
152+
If you add or remove inputs or outputs of this module, you have to update the documentation.
153+
154+
You can generate inputs and ouputs documentation of this module by running:
155+
156+
```bash
157+
$ ./docs.sh
158+
```
159+
160+
It shows markdown table of inputs and outputs, same as included in this README.
161+
125162
# License
126163

127164
Copyright © 2019 Naoto Yokoyama

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /