https://github.com/aeksco/aws-cdk-starter
A starter project using AWS CDK + TypeScript
https://github.com/aeksco/aws-cdk-starter
Last synced: about 1 year ago
JSON representation
A starter project using AWS CDK + TypeScript
- Host: GitHub
- URL: https://github.com/aeksco/aws-cdk-starter
- Owner: aeksco
- License: mit
- Created: 2022-08-24T17:05:00.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-29T06:42:52.000Z (over 2 years ago)
- Last Synced: 2025-02-10T15:50:36.403Z (over 1 year ago)
- Language: TypeScript
- Size: 1.66 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# aws-cdk-starter
:briefcase: A starter kit for provisioning infrastructure on AWS. Built with AWS CDK + TypeScript.
Includes example implementation for the following:
1. Launch Puppeteer in Lambda
2. Navigate to web page
3. Take screenshot
4. Upload screenshot to S3
5. Expose screenshots via API
**Getting Started**
Run the following commands to install dependencies, build the CDK stack, and deploy the CDK Stack to AWS.
```
yarn install
yarn build
cdk bootstrap
cdk deploy
```
### Scripts
- `yarn install` - installs dependencies
- `yarn build` - builds the production-ready CDK Stack
- `yarn test` - runs Jest
- `yarn prettify` - run prettier against the source files
- `cdk bootstrap` - bootstraps AWS Cloudformation for your CDK deploy
- `cdk deploy` - deploys the CDK stack to AWS
**Notes**
- Includes very basic tests with Jest.
**Built with**
- [TypeScript](https://www.typescriptlang.org/)
- [Jest](https://jestjs.io)
- [AWS CDK](https://aws.amazon.com/cdk/)
- [AWS API Gateway](https://aws.amazon.com/api-gateway/)
- [AWS Lambda](https://aws.amazon.com/lambda/)
**Additional Resources**
- [CDK API Reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-construct-library.html)
- [CDK TypeScript Reference](https://docs.aws.amazon.com/cdk/api/latest/typescript/api/index.html)
- [CDK Assertion Package](https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/assert)
- [awesome-cdk repo](https://github.com/eladb/awesome-cdk)
**License**
Opens source under the MIT License.
Built with :heart: by [aeksco](https://twitter.com/aeksco)