Pulumi Starter Kit

Hi everyone, we're giving open source a shot! This package will be slowly populated. For now, it's being published for some of my substack guide blog posts.

General Information

To keep the package light, we've steered away from hard dependencies. See /examples/ for more. You will need:

• @pulumi/pulumi v3.0.0 or higher installed.
• To use the relevant constructs, you'll also need:
  • @pulumi/random
  • @pulumi/aws
  • @pulumi/azure
  • @pulumi/gcp
  • @pulumi/cloudflare

Requirements

• JQ from their Official Page or "brew install jq". We also recommend:

  # Set JQ for AWS CLI by adding the following to ~/.aws/config:
  cli_pager = jq
  output = json

• A logged in AWS CLI or "brew install awscli"

• A logged in Pulumi CLI or "brew install pulumi"

• An initialized Pulumi Stack, or use "./examples"

Local Development

You will need Bun

Create a *.env file in root and set the repository where you'd like this package used in it, like so:

# Single Path Where "/home/YOUR_USERNAME/YOUR_PROJECT/package.json" exists
DEV_TARGET=/home/YOUR_USERNAME/YOUR_PROJECT

# Multiple Paths
DEV_TARGET=/home/YOUR_USERNAME/YOUR_PROJECT,/home/YOUR_USERNAME/YOUR_SECOND_PROJECT

Run "npm run dev" to start the watcher. This will copy the package to the target directory on every change and clean up after.

Extras

You may find the nodemon setup along with ./.devmode.sh + ./devmode.ts a useful pattern.

You may also find ./.vscode/settings.json + ./.github/copilot-instructions.md useful.