https://github.com/paulsenon/tpl-aws-cdk-dockerized-dev-env
bootstrap template project to clone the exec ./bootstrap.sh
https://github.com/paulsenon/tpl-aws-cdk-dockerized-dev-env
aws cdk dev-environment docker template
Last synced: 6 months ago
JSON representation
bootstrap template project to clone the exec ./bootstrap.sh
- Host: GitHub
- URL: https://github.com/paulsenon/tpl-aws-cdk-dockerized-dev-env
- Owner: PaulSenon
- Created: 2025-02-04T11:02:33.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-13T09:37:04.000Z (about 1 year ago)
- Last Synced: 2025-03-29T16:29:12.816Z (11 months ago)
- Topics: aws, cdk, dev-environment, docker, template
- Language: Makefile
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.final.md
Awesome Lists containing this project
README
# [YOUR PROJECT NAME]
This is a CDK Typescript infrastructure (fully dockerized) for [...]
## Requirements
- docker
- docker compose
- make
## Install dependencies
```bash
make install
```
the first time you will be prompted to configure the aws sdk with the account you want to use. It works with both sso or access keys.
## Cleanup (to remove all generated files and save space)
```bash
make clean
```
## Force Rebuild in case of issues
```bash
make install-force
```
## Enter dev env (to run any command like cdk, npm, aws, etc )
```bash
make dev
# that is a alias for
make bash
```
but if you don't want to enter the dev env bash, you can run this others make commands that are shortcut you can run from you host machine:
### CDK Commands
| Command | Description |
|---------|-------------|
| `make cdk-bootstrap` | Bootstrap CDK in your AWS account |
| `make cdk-synth` | Synthesize CloudFormation template |
| `make cdk-diff` | Show changes to be deployed |
| `make cdk-deploy` | Deploy the CDK stack |
| `make cdk-destroy` | Destroy the CDK stack |
### AWS Commands
| Command | Description |
|---------|-------------|
| `make aws-configure` | Configure AWS profile (sso or access key & secret) |
| `make aws-login` | Login to AWS SSO |
### Docker Commands
| Command | Description |
|---------|-------------|
| `make docker-build` | Build the Docker image |
| `make docker-build-force` | Build the Docker image without cache |
| `make docker-build-debug` | Build the Docker image with debug output |
| `make docker-clean` | Remove Docker containers, images, and volumes |
| `make docker-down` | Stop all containers |
### Package Manager Commands
| Command | Description |
|---------|-------------|
| `make npm-install` | Install dependencies |
| `make npm-upgrade` | Upgrade all dependencies |
| `make npm-clean` | Clean dependencies and generated files |
### Other Commands
| Command | Description |
|---------|-------------|
| `make corepack-upgrade` | Upgrade corepack to the latest version |
| `make run cmd="..."` | Run arbitrary command in dev container without entering it (from host then)|
| `make help` | Display help with all available commands |