Overview

Boilerplate project for Node.js applications using TypeScript with test, lint, code formatter already configured. Check the Key Features section for more details.
The preferable way to use this boilerplate is using npx command. You can use npm init too.
Use the following commands to bootstrap a new project:

NPX

npx boilerplate-typescript --no --app=your-app

NPM Init

npm init boilerplate-typescript -- --app=your-app

Without parameters, the project will be created on a folder my-app in the same directory where you executed the command.
All parameters available:

--destination=<FOLDER_DESTINATION> Defaults to the current directory
--app=<APP_NAME> Defaults to my-app

The final folder will the parameter destination, if provided, concatenated with the parameter app.

ESM

The project template now uses ESM by default.

Docker

Minimalist docker image generation.
Check this Dockerfile.

Local Dev Environment

Run make up to spin up a local environment with Docker Compose.
Check this docker-compose.yml for more details.

Key Features

• ESM (ECMAScript Modules): Uses ESM by default for module management.
• TypeScript: Provides strong typing and modern JavaScript features.
• Jest: Configured for unit testing.
• EsLint: Ensures code quality and consistency.
• Husky: Manages Git hooks.
• Commit Lint: Enforces conventional commit messages.
• Lint Staged: Runs linters on staged Git files.
• Prettier: Formats code for readability.
• Nodemon: Automatically restarts the application on file changes during development.
• Docker: Includes a minimalist Docker image generation.
• Docker Compose: Sets up a local development environment with Docker Compose.

License

This project is MIT Licensed.