TypeScript

This is TypeScript template.

Content

• Dockerfile
• GitHub Actions
• jest
• esbuild
• express
• tsoa

Getting Started

Dev Container

System requirements:

• [WSL 2 (Windows only)]¹
• [Docker CE/EE 18.06+]²
• [Visual Studio Code]³ with [Dev Containers]⁴
  • We recommend to install [Remote Development]⁵ instead.

This project provides a Visual Studio Code Dev Container with all dependencies and extensions pre-installed. Please follow the [setup instructions]⁶ to configure Visual Studio Code.

With Visual Studio Code setup, you will be prompted to open the repo in a Dev Container, or you can choose Dev Containers: Reopen in Container from the Visual Studio Code command palette.

Local Development

System requirements:

• [Node.js]⁷ >= 16.13.0
  • We recommend using a version in Active LTS.
• [pnpm]⁸ >= 7.0.0

We recommend that you use [Visual Studio Code]³ to work on the CDK. We use prettier and eslint to keep our code consistent in terms of style and reducing defects. We recommend installing the extensions for [prettier]⁹ and [eslint]¹⁰ as well.

Footnotes

1. https://docs.microsoft.com/en-us/windows/wsl/install ↩

2. https://docs.docker.com/install/#supported-platforms ↩

3. https://code.visualstudio.com/ ↩ ↩²

4. https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers ↩

5. https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack ↩

6. https://code.visualstudio.com/docs/remote/containers-tutorial ↩

7. https://nodejs.org/ ↩

8. https://pnpm.io/ ↩

9. https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode ↩

10. https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint ↩