msolorio/node-typescript-express-boilerplate

Boilerplate for Node,TypeScript, Express projects

Node TypeScript Express Boilerplate

👩🏻‍💻 Developer Ready 🏃🏽 Instant Value: All basic tools included and configured:

• TypeScript 5.4 Configured
• ESM modern ecmascript modules support
• Path aliasing natively with Node.js and TypeScript
• Jest for fast unit testing and code coverage
• Docker and Docker Compose configuration
• NPM scripts for common operations
• ESLint with some initial rules recommendation
• Prettier to enforce consistent code style
• EditorConfig for consistent coding style
• GitHub Actions configuration for CI
• Makefile scripts for common developer operations

Getting Started

Start adding your code in the src and tests in the __tests__ directories.

Setup

To setup the project run the following commands:

git clone git@github.com:msolorio/node-typescript-express-boilerplate.git
cd node-typescript-boilerplate
make build
make up
make test

Make Scripts

Developer facing scripts to build, run, and test the application.

• make build - Build docker container
• make dev - Start app in watch mode
• make test - Run tests
• make up - Start from compiled code
• make down - Remove container
• make logs - Show container logs
• make run cmd=<command-to-run> - Runs command in container

ES Modules

This template uses native ESM.

If your project requires CommonJS, you will have to convert to ESM.