DEV Community: chrishart0

NextJS 13 Hero Component – How to Use Next/Image for Cover

chrishart0 — Sun, 11 Jun 2023 16:05:07 +0000

See in the above example how my cover image looks. At the time of writing this, this page is MyChefAI.com/diabetes.

Here is my full hero image component

import { styled } from "@mui/system";
import Link from "next/link";
import Image from 'next/image';

//MUI Components
import { Box, Button, Typography } from "@mui/material";

function DiabetesLandingHero({handleScroll}) {
  const HeroImage = styled("div")(({ theme }) => ({
    position: "relative",
    height: "80vh",
    display: "flex",
    alignItems: "center",
    justifyContent: "center",
    overflow: "hidden",
    color: "white",
    textAlign: "center",
    textShadow: "1px 1px 3px rgba(0, 0, 0, 0.4)",
  }));

  const ImageOverlay = styled("div")(({ theme }) => ({
    position: "absolute",
    top: 0,
    bottom: 0,
    right: 0,
    left: 0,
    backgroundColor: "rgba(0, 0, 0, 0.5)", // semi-transparent black overlay
  }));

  const TextContent = styled("div")(({ theme }) => ({
    position: "relative",
    paddingTop: theme.breakpoints.up("md") ? "10vh" : "5vh",
    color: theme.palette.common.white,
    position:"relative",
    margin: theme.spacing(1),
    textShadow: "2px 2px 4px rgba(0, 0, 0, 0.5)", // text shadow
    display: "flex",
    alignItems: "center",
    justifyContent: "center",
    flexDirection: "column",
    height: "100%",
    zIndex: 1, // Added a z-index so that this div stays above the Image component
  }));

  return (
    <HeroImage>
      <Image
        src="/hero-image.webp"
        alt="Hero Image"
        priority={true} 
        loading='eager'
        fill
        style={{objectFit:"cover"}}
        quality={100}
      />
      <ImageOverlay />
      <TextContent>
        <Typography variant="h2" component="h1" sx={{ paddingBottom: "2vh", fontSize: (theme) => theme.breakpoints.down('md') ? '2.5rem' : '3rem' }}>
          My Chef AI for Diabetes
        </Typography>
        <Typography variant="h4" gutterBottom sx={{ fontSize: (theme) => theme.breakpoints.down('md') ? '1.5rem' : '2rem' }}>
          Recipes crafted to your unique needs.
        </Typography>
        <Typography variant="h6" sx={{ fontSize: (theme) => theme.breakpoints.down('md') ? '1.2rem' : '1.5rem' }}>
          Managing Type 1 or 2 diabetes? Turn your dietary needs into tasty, tailored meals. Make your food work for you.
        </Typography>
        <Link href="/chat" passHref>
          <Button
            variant="contained"
            size="large"
            sx={{ mt: 4, color: "primary.contrastText", fontSize: (theme) => theme.breakpoints.down('md') ? '0.9rem' : '1.5rem' }}
          >
            Join & Start Cooking!
          </Button>
        </Link>
      </TextContent>
      <Box
        sx={{
          position: "absolute",
          bottom: 8,
          left: "50%",
          transform: "translateX(-50%)",
          cursor: "pointer",
        }}
        onClick={handleScroll}
      >
      </Box>
    </HeroImage>
  );
}

export default DiabetesLandingHero;

How to use next/image for cover image

As show in the codeblock above, how you can specifically use Next/Image as a cover is this:

<div style={{position:"relative"}}>
  <Image
      src='/cover.webp'
      fill
      style={{objectFit:"cover"}}
    />
</div>

This code is from my new personal project MyChefAI.com/diabetes. A free tool for helping diabetics get better recipes.

Rescue Your Soul From AWS CDK Dependency Hell and Improve Your DevEx With 3 Musketeers

chrishart0 — Tue, 22 Feb 2022 19:14:17 +0000

Cross post: Medium | Arcadian

GitHub Repo: https://github.com/chrishart0/aws-cdk-typescript-3-musketeers

This is an example of containerized AWS CDK following the 3 Musketeers pattern.

What Is This 3 Musketeers Thing Anyway and Why Would I Want to Do Such a Thing as to Containerize the AWS CDK?

Links:

3 Musketeers for an epic Developer Experience
What is 3 Musketeers?
What is AWS CDK

There are a host of benefits to the 3 Musketeers pattern, which mostly center around Developer Experience. 3 Musketeers packages all the dependencies up into one container, making it easy for the whole team to stay up-to-date. The other substantial benefit I see of the 3 Musketeers pattern is just how darn easy it makes it to set up new developers. Simply make sure they install docker, docker-compose, and make (also WSL on Windows). Now setup for new projects is as simple as cloning down the repo and running make install.

If you’ve worked on any number of CDK projects, you’ve probably run into hiccups with dependency management, and you know how difficult these issues can be to fight through, especially for developers new to Node. It should be obvious now how 3 Musketeers can mitigate these.

Getting Started

Now that we’ve seen why it’s a good idea to use the 3 Musketeers pattern with the AWS CDK, let’s jump right into it.

Start by cloning down this repo from GitHub: https://github.com/chrishart0/aws-cdk-typescript-3-musketeers

This will have everything you need to try out containerized AWS CDK. Let’s go through the contents of this repo first.

Notice that the infrastructure directory is the output of running the command cdk init sample-app — language typescript. This gives us a basic sample app to work with. If you aren’t familiar with the AWS CDK in typescript, the infrastructure/lib/infrastructure-stack.ts file is where the infrastructure to be deployed is located. You will notice an SQS queue and an SNS topic have been defined with the queue subscribed to the SNS topic.

You can use this repo as is or replace the contents of infrastructure with your work.

How to Use this Repo as a Starting Point

Note: You don’t need an AWS account setup to test this locally, simply skip running the bootstrap command

Open up the CLI into the root of the repo you’ve cloned down locally.

Run the command make; this will do all the needed setup and run cdk synth from within the docker container.

$ make

If you have never used AWS CDK in your configured AWS account before then you must run the CDK bootstrapper. If you simply want to test this repo out locally you can skip this step.

$ make bootstrap

You are now free to run any other commands available such as cdk diff, cdk deploy, and cdk destroy

Gif of make deploy running

Use this in an existing project

If you have an existing project and would like to use this 3 Musketeers pattern then follow these steps:

Copy the Makefile, Dockerfile, and docker-compose.yaml files into the root of your project
Update the CDK_PATH variable in three_musketeers.env and Makefile
Run make to do initial setup and output cdk synth to verify everything is configured right For more information refer to the README on the GitHub repo. I’d love to hear any thoughts, comments, or critiques in the comments below.

How to Use Tesseract OCR to Convert PDFs to Text

chrishart0 — Mon, 21 Feb 2022 00:36:40 +0000

This is a cross-post from my blog Arcadian.Cloud, go there to see the original post.

I have some PDFs which I need to get typed up into text to edit. I decided to go with Tesseract OCR as it seems to be the best tool for the job. Here are the steps for how to use Tesseract OCR to convert PDFs to text.

Installation

First things first, get Tesseract CLI installed. Follow the instructions here, these are linked to from the official Tesseract docs.

sudo add-apt-repository ppa:alex-p/tesseract-ocr-devel
sudo apt-get update
sudo apt install tesseract-ocr tesseract-ocr-eng

Note: the package didn’t properly place the eng.traineddata file for me. If you get an error about this refer to the troubleshooting steps at the bottom of this article.

Usage

In the CLI, cd into the directory with the images or PDFs you want to convert.

Remember, Tesseract cannot convert PDFs, so first we must convert the PDF to a .tiff file, then we can convert the .tiff to text.

#Convert the PDF to a .tiff file, change out the file names at the end of this command to your own
#Note: If you get an error about security policy check the troubleshooting section below
convert -fill white -draw 'rectangle 10,10 20,20' -background white +matte -density 300 Loring-Lombard-Autobiogrphy-Pages1-10.pdf Loring-Lombard-Autobiogrphy-Pages1-10.tiff

#Tesseract will add .txt to the end of the new file name
tesseract Loring-Lombard-Autobiogrphy-Pages1-10.tiff Loring-Lombard-Autobiogrphy-Pages1-10

I was able to safely ignore these errors. Once the PDF to .tiff conversion finished I ran the tesseract command to created the text file.

You should now have a text file created. It really is as easy as that to Use Tesseract OCR to Convert PDFs to text files.

Troubleshooting

Missing Language Training Data

If you see something like the bellow error message it means you missed installing the English training data.

Error opening data file /usr/share/tesseract-ocr/5/tessdata/eng.traineddata
Please make sure the TESSDATA_PREFIX environment variable is set to your "tessdata" directory.
Failed loading language 'eng'
Tesseract couldn't load any languages!
Could not initialize tesseract.

Simply install the tesseract-ocr-eng package with the below command:

sudo apt install tesseract-ocr-eng

If this doesn’t fix it then check out this GitHub issue for more troubleshooting steps.

Convert Tool Security Policy Error

convert-im6.q16: attempt to perform an operation not allowed by the security policy `PDF' @ error/constitute.c/IsCoderAuthorized/421.
convert-im6.q16: no images defined `converted-pdf.tiff' @ error/convert.c/ConvertImageCommand/3229.

To fix the above error you need to edit or get rid of the imagemagic security policy. The simplest solution is to temporarily rename the security policy but this may be dangerous if you forget to put it back. Instead, I recommend just edit the policy and remove the offending policy.

sudo sed -i 's/^.*policy.*coder.*none.*PDF.*//' /etc/ImageMagick-6/policy.xml

Checkout this StackOverflow post for more details on working around this error.

Enable Lambda Insights Using Python AWS CDK

chrishart0 — Tue, 23 Nov 2021 03:17:17 +0000

Code for enabling Lambda Insights with the Python CDK

# Define the layer, make sure you use the right layer for your region and the pick the most up to date layer https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-extension-versions.html

layerArn='arn:aws:lambda:us-east-1:580247275435:layer:LambdaInsightsExtension:14'
insight_layer = _lambda.LayerVersion.from_layer_version_arn(self,'lambda_insights_layer',layerArn)

#Add the layer to the function as shown below
_lambda.Function(
    self, 'my_function',
    runtime=_lambda.Runtime.PYTHON_3_8,
    handler='my_function.handler',
    code=_lambda.Code.from_asset(
        path = 'lambda'
    ),
    layers=[insight_layer]
)

# Optional: Add the managed policy 
If using the `AWSLambdaBasicExecutionRole`, which CDK uses by default when creating a Lambda function, there is no need to do this. Otherwise, add the `CloudWatchLambdaInsightsExecutionRolePolicy` managed policy to the function.

Note: make sure to pick the most up to date and correct region ARN for the Lambda Insights Extension layer. Reference these docs here for ARNs for all regions and version

Here are the AWS docs on how to enable Lambda Insights for the Typescript CDK.

Configure CORS for an S3 Bucket Using Python AWS CDK

chrishart0 — Tue, 23 Nov 2021 02:41:54 +0000

Get right to it, here is the code

Python CDK code for configuring CORS on an S3 bucket.

bucket = s3.Bucket(self, "myBucket",
    cors=[
        s3.CorsRule(
            allowed_headers=[CORS_headers],
            allowed_methods=[s3.HttpMethods.PUT, s3.HttpMethods.POST, s3.HttpMethods.GET, s3.HttpMethods.DELETE],
            allowed_origins=[CORS_url]
        )
    ]
)

A list of the HTTP methods which can be configured can be found here in the aws_cdk.aws_s3.HttpMethods docs

Relevant docs:

Create S3 Lifecycle Rules with Tag Filters Using Python AWS CDK

chrishart0 — Thu, 21 Oct 2021 23:55:21 +0000

Get right to it, here is the code

Python CDK code for creating an S3 bucket with a lifecycle rule which uses a tag filter.

bucket = s3.Bucket(self, "myBucket",
    lifecycle_rules = [
        s3.LifecycleRule(
            id="example-rule-made-with-python-cdk",
            expiration=core.Duration.days(1),
            tag_filters={ 
                'Key': 'delete_in_1_day', 
                'Value': 'true'
            }
        )
    ]
)

Relevant CDK docs:

Note: AWS Lifecycle rules do not get more precise than 24 hours[docs].

Create CloudWatch Alarms with Python AWS CDK

chrishart0 — Thu, 21 Oct 2021 23:24:14 +0000

Create the alarm

Put this into your Python AWS CDK stack to create an alarm on a bucket asigned to a varibale named bucket

bucket = s3.Bucket...

s3_size_alarm = cloudwatch.Alarm(self, 'bucket_overloaded_alarm',
    metric= cloudwatch.Metric(
        namespace = "AWS/S3", 
        metric_name = "BucketSizeBytes",
        dimensions={
            "BucketName": bucket.bucket_name,
            "StorageType": "StandardStorage",
        },
        period = core.Duration.days(1),
        statistic="Maximum",
    ), 
    evaluation_periods=1, 
    threshold=1000000000 #1 GB
)

This will create a CloudWatch alarm which:

Alarm if the size of the bucket goes over 1GB
Only monitors objects with the StandardStorage type

Relevant CDK docs:

Warning: Don't rely on an alarm watching the BucketSizeBytes metric to make sure your bucket doesn't grow too large. This metric is only collected once a day. Consider opting in to S3 request metrics for more in-depth S3 monitoring

Create alarm action

Alarms aren't very useful if they don't do anything. Setup some actions:

topic = sns.Topic.from_topic_arn(self,'snstopic',"arn:aws:sns:us-east-1:123456789012:alarm-go-ahhhhhhhhhhhh")

s3_size_alarm.add_alarm_action(
    cloudwatch_actions.SnsAction(
        topic = topic
    )
)

Relevant CDK docs:

https://docs.aws.amazon.com/cdk/api/latest/python/aws_cdk.aws_sns/Topic.html#aws_cdk.aws_sns.Topic.from_topic_arn

You Are Using Story Points Wrong: How to Make Story Points Suck Less

chrishart0 — Thu, 21 Oct 2021 17:41:55 +0000

Realistic representation of how you will actually look when you finish reading this article and show off your story pointing knowledge to your friends, family, and co-workers.

Preamble

Cross-Post from Medium Post

Amongst people in the software industry there is a lot of confusion around story points. This blog is my summary of great minds opinions on the topic of story points with some of my own opinions throw in as well.

Story points are part of scrum, right? No. Go read the scrum guide(link) yourself, there is no mention of story points or even user stories. Don't adopt story points as a default, adopt them because they are solving a problem.

The goal of this article is not to give the reader a set of hard rules. Instead, the reader should work to understand this as a starting point and then evolve into what best suits the team.

Got a question or disagree with something? Leave it in the comments.

What are Story Points?

Story points are an arbitrary, imprecise, and relative estimate of effort, complexity, and uncertainty.

Relative

Story points are relative to previously sized stories.

Arbitrary

A team invents their own pointing system. The first story sized is given an arbitrary point value as decided by the team, from then on stories are sized in relation to that story.

This means that the first sets of stories won't be as useful as they have nothing to be relative to and many assumptions have to be made. The first stories are intended to be the first step in making future relative decisions, so this is okay.

Size Parameters

What goes into a size?

Complexity
Uncertainty
Effort

Learn from the past to improve future estimates!

Story Points are Not

Estimate of time
- Very difficult to estimate time, hard to get right
- Story points trade off precision to make estimating easier
Exact end dates
Exact time spent
Time tracking
For comparing team's output
- Story points are, by definition, relative and unique to each team
  - Thus, comparing one team's velocity to another team's velocity is pointless(pun intended)
- Once points leave a team they are useless

Why Story Points?

Story points are an imprecise forecast of a team's capacity/velocity, helping to develop shared understanding, and useful in negotiating task priority.

Before deciding to use story points it is crucial to have a good understanding of why you want to use them. What benefits will the team get from story points? What are the downsides?

Nowadays(2021), many experts recommend not using story points at all. Mostly, this sentiment comes from companies being tempted to weaponize story points against their developers. Read more about the no story points debate here.

Why should we use story points? Why not just estimate time?

Cost of estimation is low
- Imprecise, allows us to more quickly make estimations
High accuracy and low precision
- Relative sizing requires less effort to be accurate than time based estimations
  - Asking how complex / effortful is this thing compared to that thing is much easier than estimating how long it will take
- Imprecision of story points allows for quick estimation

Purposes

Please note that this is a contentious topic, there is debate on what all uses story points should be put.

Negotiating Priority

"If you want A by the end of the month then we are going to have to push B until next month."
Stops the team from committing to doing to much in a period(iteration)
- A metric to be used to push back against excessive work and prevent burn-out
Helps the team to say no
- "Provides healthy boundaries for the team"
- Be careful not to show the numbers, they are for the product team's use only
  - Don't allow story points to be turned into a currency
Useful for using stories on a prioritization matrix

Shared Understanding

If a story is sized, it shows the team has developed a shared understanding of what it will take to complete it
Story points are a prompter for conversation to get the whole to understand what will go into completing the task
"What are you thinking so I can think like that?"
- Get in the same head space about everything which will go into a story
  - Example:
    - John: "This is about a 1, we just need to make a quick update to the Shaw-Fujikawa Translight function."
    - Jill: "You're forgetting we have not implemented automated testing for rupture generation, this will be a 3."

Slicing Signal

A signal that a task has not been broken down enough

"That is a lot of points, has this been broken down enough?"
"Can this fit into the iteration?"

How to use Story Points

Make sure to remember the first few iterations the estimates will be highly inaccurate, over time this will improve
Map story points to approximate effort/complexity/uncertainty

Story Pointing Frameworks

There are a number of frameworks for story points.

Here are a few, listed below:

T-shirt sizes (S, M, L, XL) (easy to start with)
Integers: tools like Jira can provide burndown charts, scope creep indicators and other metrics when using integers
- Standard: (1, 2, 3, 4, 5, ect)
- Fibonacci-style scale (0, 1, 2, 3, 5, 8)
  - Fibonacci-style scale without 2 (0, 1, 3, 5, 8)
    - "Less is more"
  - Why use Fibonacci? Here is a good article
Time based (antiquated, not recommended)
- Caution: these are not recommended for reasons documented elsewhere in this article
  - Read more here on why story points are better than time
- Time
- Ideal Time

Tips for Choosing a Framework

Items to consider when the team is deciding on their story pointing framework

Less is more

You don't want to allow for too many options, this will lead to analysis paralysis. Remember, story points are meant to be imprecise, we don't want to spend too much time trying to pick the perfect number.

We are trading off precision for ease of use on purpose.

Upper Limit

Decide on an upper limit of effort/complexity (e.g. your team may decide that for them a 13 is "too large for one feature/story")

If a story breaks the upper limit then it needs to be broken down into smaller pieces.

Have it your way

Teams should pick their own standard, it shouldn't be imposed by anyone else. Remember, story points are to be used by the team for themselves.

Planning for new teams

When a new team comes together their estimates will be difficult to agree on and very uncertain, that's okay, they don't have a point of reference yet.

Find 1-2 well defined/known stories and understand "what a 1 vs 3 vs 5 looks like". Once the team has these stories, they can start to use relative estimation.

Golden Story

Some teams use what is called a golden story. This is the first story estimated for a product. It is then used as a point of reference throughout the lifecycle of the product.

For another take on golden stories checkout this article on the Blizzard Computing blog.

Example of a team developing a pointing standard:

The team decides on 1-8 of the fibonacci sequence, so 3 is a medium 1 is extra small, and 8 is extra large.

Example Estimation

Login is a story of about medium size, the team guess, so they decide to size it as a 3
Next sprint, the team sizes logout
- 3 parameters
  - Complexity: Logout is a lot simpler than login
  - Effort: There will be a lot less work to do than with login
  - Uncertainty: Since the team just worked on login, the uncertainty is low, they are familiar with the code around this functionality and have a good idea of what needs to be done
- Assessing logout in relation to Login, the complexity is lower, there is less effort needed, and the uncertainty is low
- The team decides to size logout as a 1
The following sprint, the team needs to estimate a story for allowing the user to update their email
- 3 parameters
  - Complexity: Updating email touches a lot of pieces, the UI, the API, the DB, as well as having the user verify the new email
    - Certainly less complex than login but probably a bit more complex than logout
  - Effort: The complexity suggests the effort will be between logout and login
  - Uncertainty: There isn't too much uncertainty here, the team has sent emails from the application before and nothing else is too experimental
- The team decides this is larger than logout but smaller than login, so they estimate it at a 2.
Next up, the business has asked us to port over 102 static pages from an old application
- 3 parameters
  - Complexity: Complexity is very low, these are just simple html and css pages which need to be copied over, maybe a few small css changes here and there just make them fit in
  - Effort: Effort is high, there are 102 pages to port over, largely this is an effort in using copy and paste
  - Uncertainty: The uncertainty is low, just some basic pages added to the UI
  - While the complexity and uncertainty are low, the team decides, in relation to the other stories, this should be sized the same as login due to the large amount of effort it will take to move over all the pages over
  - The story gets a 3

Example Takeaways

Notice how in the example we did not discuss time, but always talked about effort, complexity, and uncertainty. This is how story points should be thought of.

These sizes are not meant to be precise, they are meant to be quick and easy.

What to watch out for

Talking about days

Remember to use relative effort/complexity/uncertainty, not time.

Spending too much time discussing process intricacies

Don't get stuck in the weeds.

Don't get stuck in the weeds. If there are some "3s" and a "5" then don't spend a lot of time discussing if you should introduce a "4"

Management manipulating with the team's points

What happens when the team doesn't agree?

The team votes at the same time to avoid influencing each other, in human psychology that's called anchoring.

The team then discuss the sizes to achieve consensus.

Achieve shared understanding

The team discuses the story with the goal of achieving shared understanding.

Figure out why the team does not agree

Is there something part of the team isn't thinking about? Refer back to the example in the Develop Shared Understanding section.

Maybe less experienced devs are estimating higher due to more uncertainty on their part. In this case, pick a team norm for how to handle this and move on quickly. Some possible norms would be taking the average if there is a wide range or taking the larger size if the sizes are close.

The pattern to avoid is spending many minutes during a team-wide meeting debating back and forth. If the story needs more more work, drop it and save it for later, don't waste the whole teams time.

History

The term 'Story points' originated in the late 1990s from the XP concept of "ideal time". Ron Jeffries may have been the originator of this term.

Read more about story point history here:

How to work within an imposed framework will vary from team to team.

More Resources:

Blogs

Videos

What are Story Points? by Mountain Goat Software(Mike Cohn)

Books

Clean Agile by Robert C. Martin - p64-p81

Increase AWS CDK Lambda development speed by testing locally with AWS SAM

chrishart0 — Mon, 20 Sep 2021 14:45:31 +0000

This is a cross-post from https://medium.com/contino-engineering/increase-your-aws-cdk-lambda-development-speed-by-testing-locally-with-aws-sam-48a70987515c

Git repo with all code completed:https://github.com/chrishart0/aws-cdk-sam-demo

This article explains how to locally test, with AWS SAM(Serverless Application Model), a Lambda function + API Gateway created with AWS CDK(Cloud Development Kit).

When using AWS CDK for your infrastructure as code, it can be a pain to figure out how to efficiently test your Lambda functions. Deploying your code to AWS with cdk deploy for every change is slow, having to run a deploy for every code change is not ideal. Luckily it is straightforward to use AWS SAM to test your function locally.

For scenarios where local dev isn’t feasible, get faster deployments to Lambda with cdk deploy --hotswap

This gif demonstrates using SAM to test Lambda + API Gateway generated with CDK.

Steps 0-2 help you set up a fresh CDK project. If you already have a CDK project which creates a lambda function and API Gateway, skip ahead to step 3.

0) Prerequisites, Assumptions, and Environment

NPM Installed
Python Installed
If you don’t have AWS CDK installed follow this guide: https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html
If you don’t have AWS SAM installed, follow this guide: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html

1) Initialize a CDK project

Note: If this is your first time using AWS CDK with Python, I recommend you try out the CDK Workshop from AWS: https://cdkworkshop.com/30-python/20-create-project/100-cdk-init.html

⚠️ Optionally: you can clone the completed repo here and skip to step 3

Create a directory for your project and cd into it

$ mkdir aws-sam-cdk-demo
$ cd aws-sam-cdk-demo

Then, initialize your CDK project

$ cdk init app --language python

Create and source a python virtual environment

$ python3 -m venv .venv
$ source .venv/bin/activate

Install CDK requirements

$ pip install -r requirements.txt

Run CDK synth to ensure everything is setup correctly

$ cdk synth

You should see a small CloudFormation template get created with only the CDKMetadata resource and some conditions:

2) Create a Lambda function

In this example, I’ll be making an API that provides a greeting from a list of greetings I have hardcoded.

Create a directory for the lambda code and create a file for the code

$ mkdir lambda
$ touch lambda/greeting_generator.py

Go ahead and add some code to your function. You can copy the code from my function and tweak it as you see fit:< https://github.com/chrishart0/aws-cdk-sam-demo/blob/master/lambda/greeting_generator.py>

Install the lambda and API Gateway constructs

Add aws-cdk.aws-lambda and aws-cdk.aws-apigateway as lines to requirements.txt

Run the command to install the the lambda and API Gateway constructs.

$ pip install -r requirements.txt

Time to add lambda and API Gateway to your stack

Open the stack file.

If you aren't familiar with CDK then the stack file may be confusing, this is where infrastructure is defined in a CDK project. See here for reference stack file. The stack file was created by cdk init, it follows the naming scheme same_as_your_parent_dir/same_as_your_parent_dir_stack.py

Example: Parent folder which init was run in is aws-sam-cdk-demo
aws_sam_cdk_demo/aws_sam_cdk_demo_stack.py
Example in GitHub: https://github.com/chrishart0/aws-cdk-sam-demo/blob/master/aws_sam_cdk_demo/aws_sam_cdk_demo_stack.py

Import lambda at the top of the stack file referenced above.

from aws_cdk import (
    core,
    aws_lambda as _lambda,
    aws_apigateway as apigateway,
)

Add code to your stack to generate a lambda function.

greeting_function = _lambda.Function(
            self, 'greeting_handler',
            runtime=_lambda.Runtime.PYTHON_3_9,
            code=_lambda.Code.asset('lambda'),
            handler='greeting_generator.handler',
        )

Add code for the API Gateway. Ensure the handler is the same as the variable for the lambda function.

greeting_apg = apigateway.LambdaRestApi(
            self, 'greeting_endpoint',
            handler=greeting_function,
            description="Greeting API endpoint",
        )

The stack should now look like the image below:

Tip: Add links back to the CDK docs in your code; this will save you a lot of time hunting for the right page in the future.

Run cdk synth to ensure everything compiles. You should now see more resources in the CloudFormation output in your terminal.

3) Test that lambda function locally with SAM

Here is where things start to get a little… nutty 🐿️ (get it, like the SAM squirrel mascot???)

If you already have a CDK application with a lambda function start here!

Synthesize a template and write it to template.yaml

$ cdk synth --no-staging > template.yaml

Test the API with SAM

$ sam local start-api

In your browser or in another terminal hit the endpoint http://127.0.0.1:3000/

You can change the code of your lambda function on the fly, no need to restart SAM. Edit the source code in the lambda/ dir and call the endpoint again.

You can also test individual invocations with simulated events, this is ideal if you are not using API Gateway.

$ sam local invoke functionName -e event.json

🎉🎉🎉 Congratulations 🎉🎉🎉

You can now use this very simple strategy to test your Lambda + API Gateway in your own CDK project or use this example project as a starting point.

DEV Community: chrishart0

NextJS 13 Hero Component – How to Use Next/Image for Cover

Rescue Your Soul From AWS CDK Dependency Hell and Improve Your DevEx With 3 Musketeers

What Is This 3 Musketeers Thing Anyway and Why Would I Want to Do Such a Thing as to Containerize the AWS CDK?

Getting Started

How to Use this Repo as a Starting Point

Use this in an existing project

How to Use Tesseract OCR to Convert PDFs to Text

Installation

Usage

Troubleshooting

Missing Language Training Data

Convert Tool Security Policy Error

Enable Lambda Insights Using Python AWS CDK

Code for enabling Lambda Insights with the Python CDK

More CDK or AWS Serverless Questions?

Configure CORS for an S3 Bucket Using Python AWS CDK

Get right to it, here is the code

More CDK or AWS Serverless Questions?

Create S3 Lifecycle Rules with Tag Filters Using Python AWS CDK

Get right to it, here is the code

More CDK or AWS Serverless Questions?

Create CloudWatch Alarms with Python AWS CDK

Create the alarm

Create alarm action

More CDK or AWS Serverless Questions?

You Are Using Story Points Wrong: How to Make Story Points Suck Less

Preamble

What are Story Points?

Relative

Arbitrary

Size Parameters

Story Points are Not

Why Story Points?

Purposes

Negotiating Priority

Shared Understanding

Slicing Signal

How to use Story Points

Story Pointing Frameworks

Tips for Choosing a Framework

Less is more

Upper Limit

Have it your way

Planning for new teams

Golden Story

Example of a team developing a pointing standard:

Example Estimation

Example Takeaways

What to watch out for

Talking about days

Spending too much time discussing process intricacies

Management manipulating with the team's points

What happens when the team doesn't agree?

Achieve shared understanding

Figure out why the team does not agree

History

More Resources:

Blogs

Videos

Books

Increase AWS CDK Lambda development speed by testing locally with AWS SAM

0) Prerequisites, Assumptions, and Environment

1) Initialize a CDK project

2) Create a Lambda function

Install the lambda and API Gateway constructs

Time to add lambda and API Gateway to your stack

3) Test that lambda function locally with SAM

🎉🎉🎉 Congratulations 🎉🎉🎉