aws / aws/industry-toolkit

[FEATURE] Add support for Typescript

Open
#13 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
13
Forks
1
PR merge metrics
No merged PRs in 30d

Description

# Add Support for TypeScript in Industry Toolkit

**Description:**
We need to extend the Industry Toolkit to support TypeScript. This feature will include a template for a TypeScript service implementation along with the necessary CDK configuration to deploy it on AWS. The template should follow best practices for TypeScript services and include deployment infrastructure using AWS CDK.

### Feature Requirements:
- Create a template for a TypeScript service that fits into the Industry Toolkit.
- Add CDK infrastructure to deploy the TypeScript service (e.g., Lambda, ECS Fargate, or EC2).
- Ensure compatibility with existing API-first development workflows supported by the Industry Toolkit.
- Write comprehensive tests to validate the service template and deployment.
- Provide clear documentation and a README file for users to understand how to use the template.

### Acceptance Criteria:
- [ ] A template for TypeScript and CDK to deploy the service is completed.
- [ ] Tests are written and passing.
- [ ] README is completed with instructions on using the template.
- [ ] Documentation explaining how to deploy the service using CDK is included.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the existing Industry Toolkit templates and its API-first workflow to determine how a TypeScript service should fit. Define the service template, AWS CDK deployment approach, tests, README instructions, and deployment documentation; done means all listed acceptance criteria are met and the tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
api, cloud, documentation, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.