node-boilerplate 🚀

Developer Ready: A comprehensive template. Works out of the box for most Node.js projects. This project is intended to be used with the latest active LTS release of Node.js.

Instant Value - All basic tools included and configured:

• 🚀 Typescript >= 5.3
• 🌐 Node.js >= 20.10.0
• 🧅 Use Bun as package manager
• 🌈 ES
• 🧪 Biome for code formatting and linting
• ✅ Jest or Bun test for fast unit testing and code coverage
• 📚 Type definitions for Node.js and Jest
• ⚙️ EditorConfig for consistent coding style
• 📦 NPM scripts for common operations
• ⚡ Reproducible environments thanks to Volta
• 🛠️ Example configuration for GitHub Actions
• 📝 Simple example of TypeScript code and unit test
• 🐗 Run tasks with Grunt (example for backup)
• 🚄 Build faster with ESBuild
• 🖥️ Ungit for version control (git) with a GUI
• 🔑 Dotenv for environment variables
• 🔄 Nodemon for automatic restarts node server in development
• 🔌 Tsc-watch for automatic transpile source files in development
• 📘 Runtime library for TypeScript helpers with tslib
• 🗃️ Utility functions for working with ts-api-utils

📌 Usage

To use this template, use the following commands:

bun create github.com/RajaRakoto/node-boilerplate <project-name>
cd <project-name>
bun run pkg-upgrade # to upgrade outdated dependencies in interactive mode

NOTE 1: I employ the MIT license for this starter kit, which includes my name and GitHub profile. Please remember to adjust or remove it if deemed unnecessary.

NOTE 2: In order to help you better understand the structure of this boilerplate, there is a README.md file in each subdirectory of src.

NOTE 3: For certain configurations in the package.json file, you need to modify them to tailor them to your project (e.g: name, description, author, keywords, main, repository, ...).

📌 NPM Scripts

Start

• 📜 start - Run your application with Node.js.
• 📜 start:bundle - Run your application with Node.js using the bundled JavaScript file from dist.

Clean

• 📜 clean - Remove coverage data, prod, build.

Development

• 📜 dev:tsc:watch - Interactive watch mode to automatically transpile source files with tsc-watch in development.
• 📜 dev:nodemon:watch - Interactive watch mode to automatically restart Node.js server in development with nodemon.

Build

• 📜 build - Transpile TypeScript to ES6.
• 📜 build:watch - Interactive watch mode to automatically transpile source files .
• 📜 build:bundle - Bundle source files with ESbuild.

Testing

• 📜 test - Run bun test.
• 📜 test:watch - Interactive watch mode to automatically re-run tests with bun.

Linting and Formatting

• 📜 biome:start - Starts the Biome daemon server. You can specify a custom configuration file path using the --config-path option.
• 📜 biome:stop - Stops the Biome daemon server.
• 📜 biome:fix - Runs a source code check and applies automatic fixes (linter & formatter) according to the defined rules.
• 📜 biome:unsafe - Works like biome:fix, but may apply more invasive or risky changes.

Backup and Dependency Management

• 📜 backup - Backup files with Grunt.
• 📜 pkg-check - Check useless dependencies with depcheck.
• 📜 pkg-upgrade - Upgrade outdated dependencies (interactive mode) with npm-check-updates.

Versioning

• 📜 versioning - Start ungit server.

NPM Commands

• 📜 npm-version:major - Increments the major version number of your project using npm.
• 📜 npm-version:minor - Increments the minor version number of your project using npm.
• 📜 npm-version:patch - Increments the version patch number of your project using npm.

NVM

• 📜 nvm - Manage multiple node.js versions. Easily switch between node versions per project to ensure compatibility.

NOTE: dev.tsc.watch and dev:nodemon:watch script are designed to run at the same time when developing your application.

📌 Similar

You can also check out my other starter projects:

• 🚀 bun-boilerplate
• 🚀 react-boilerplate
• 🚀 next-boilerplate
• 🚀 qwik-boilerplate
• 🚀 vscode-boilerplate
• 🚀 cli-boilerplate