Skip to content

Docs: Cookiecutter project template with TypeScript Powertools setup (with SAM)  #391

Closed
@ijemmy

Description

@ijemmy

Description of the feature request

Problem statement
Setting up in TypeScript development environment is difficult and require a lot of manual steps. For users who want to test PowerTool without integrating it into an existing TypeScript project, it could take a very long time (hours, or even days to get config right).

Summary of the feature
We provide a Cookiecutter template with TypeScript PowerTool already setup. It has API + 3 functions that uses all 3 core features

Each function will use the following options:

  1. Manually
  2. Middy Middleware
  3. Decorator

Code examples
sam init --location gh:aws-samples/cookiecutter-aws-sam-typescript-with-powertools

Ref documentation

Benefits for you and the wider AWS community

  1. Ease of learning for new users. They can test it in actual live environment (required for feature like Tracer) instead of just looking at the code.
  2. Ease of starting a new project. This increases adoption speed.

Describe alternatives you've considered
N/A

Additional context
N/A

Related issues, RFCs

N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    completedThis item is complete and has been merged/shippeddocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions