Cloud-native Enterprise Node.js — Revamped

Note

This is the successor of this project and it comes with TypeScript, ESM, tsdown Rust bundler, and c8 native V8 code coverage, beyond other cutting-edge tools and approaches.

Warning

This is work in progress!

Plan

Setup

# for version control
git init
# for asdf
echo "nodejs 24.10.0" >> .tool-versions
# for npm-based package
npm init \
 --init-author-name "Marco Lehmann" \
 --init-author-url "https://m99.io" \
 --init-license "MIT" \
 --init-version "1.0.0" \
 --yes
# use ESM
npm pkg set type=module
# for .envrc
# https://direnv.net/#the-stdlib
# "Note that this functionality is not supported in .env files. If the coexistence of both is needed, one can use .envrc for leveraging stdlib and append dotenv at the end of it to instruct direnv to also read the .env file next."
brew install direnv
touch .env
echo "dotenv" >> .envrc

Initialization

# for fastify
npm install --save \
 fastify@5.6.1 \
 fastify-type-provider-zod@6.0.0 \
 zod@4.1.12
npm install --save-dev \
 typescript@5.9.2 \
 @types/node@24.7.2
echo "node_modules" >> .gitignore

The Twelve-Factor App

Configuration

npm install --save @dotenvx/dotenvx@1.51.0

Build Phase

Using tsdown

# install dependencies
npm install --save-dev \
 tsdown@0.15.7 \
 concurrently@9.2.1
# update npm scripts
npm pkg set scripts.clean="rm -rf ./dist"
npm pkg set scripts.build="tsdown --sourcemap --minify"
npm pkg set scripts.build\:watch="tsdown --sourcemap --minify --watch ./src"
npm pkg set scripts.start\:watch="node --watch-path=./dist ./dist/server.js"
npm pkg set scripts.start\:debug="node --inspect ./dist/server.js"
npm pkg set scripts.start="node dist/server.js"
npm pkg set scripts.dev="npm run build && concurrently -r \"npm run build:watch\" \"npm run start:watch\""
# update .gitignore
echo "dist" >> .gitignore
# run app with live reload
npm run dev
# test calls
curl "localhost:3000/?name=foo"
curl "localhost:3000/?name=foobar"
curl "localhost:3000/hello"

Testing

# install dependencies
npm install --save-dev c8@10.1.3
# update .gitignore
echo "coverage" >> .gitignore
# update scripts
npm pkg set scripts.clean="rm -rf ./coverage ./dist"
npm pkg set scripts.test="NODE_V8_COVERAGE=./coverage c8 -r html npx tsx --test --experimental-test-coverage src/**/*.test.ts"
npm pkg set scripts.test\:watch="npx tsx --watch --test src/**/*.test.ts"
# run tests with coverage or in watch mode
npm test
npm run test:watch

Getting Started

# test calls
curl -i "localhost:3000/health"
curl -i "localhost:3000/headers" \
 -H "Authorization: Bearer my-secret-token-that-will-not-get-logged" \
 -H "X-Will-Get-Logged: This header will still get logged"
curl -i "localhost:3000/codes?code=304"

Project Structure