hoelee/server
1
0
Fork 0
Code Issues 76 Pull Requests 13 Actions Packages Projects Releases Wiki Activity

a bit better readme

Browse Source
This commit is contained in:
Matthew Zhao
2021-03-03 18:32:43 -08:00
parent 0e9e00b185
commit 9864d02d82
1 changed files with 11 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
deploy/aws/README.md
View File

@@ -1,18 +1,15 @@
# Welcome to your CDK TypeScript project!
This is a blank project for TypeScript development with CDK.
The `cdk.json` file tells the CDK Toolkit how to execute your app.
## Useful commands
* `npm run build` compile typescript to js
* `npm run watch` watch for changes and compile
* `npm run test` perform the jest unit tests
* `cdk deploy` deploy this stack to your default AWS account/region
* `cdk diff` compare deployed stack with current state
* `cdk synth` emits the synthesized CloudFormation template
# This is the deployment Infrastructure as code for use with AWS
## configuration, please set them as env var
* `LOCALTUNNEL_BASE_DOMAIN` the base domain for the localtunnel server, must be a root domain like example.com
* `LOCALTUNNEL_ROUTE53_ID` the ID of the route53 hosted zone for the domain
## After setting the environment variables, simply run:
```npm i && cdk deploy```
## Deployed Architecture
1. This Architecture brings up a ECS fargate cluster, 2 public subnets, 2 private subnets, and 2 NAT gateways
2. It spins up a container that runs using fargate runtype with the upstream docker image
3. the container image is placed in one of the two private subnets