Module Development Environment Template with Typescript

Template for NodeJS module development with Typescript inside a VSCode Docker Container.

Requirements

• Docker Engine

• Docker Compose

• Visual Studio Code

• VS Code Remote Development Extension

• VS Code Docker Extension (optional)

Usage

1. Click Use this template
2. Select Create a new repository
3. Check the .devcontainer/docker-compose.yml file to disable unwanted services.
4. Create the .devcontainer/.env file from .env-defaults (update the HOST_PREFIX value!).
5. Update the package.json file. Set the package name and description.
6. Run the Remote-Containers: Reopen in Container... command from the Command Palette (F1) or quick actions Status bar item.
7. Install the dependencies.

To return to the local project:

• Run the Remote-Containers: Reopen Locally... command from the Command Palette (F1) or quick actions Status bar item.

Development Container

The container includes NodeJS (check .env to change version), with pnpn and Yarn installed globally.

Project Development Libraries

• Typescript
• Typedoc for generating documentation from the ts source files.
• Jest with ts-jest for testing.
• ESLint for static code analysis.

Docker Services Included

• MSSQL
• Postgres (with pgAdmin)
• MySQL (with phpMyAdmin)
• MariaDB (with phpMyAdmin)