iipanda / node-typescript-boilerplate

Opinionated Node.js and TypeScript boilerplate

Node.js + TypeScript Boilerplate

Opinionated Node.js and TypeScript boilerplate

🚀 Included

• Node.js and TypeScript, obviously
• ESLint + typescript-eslint for linting
• Prettier for code formatting
• Renovate for automatic dependency updates
• Visual Studio Code workspace config
• Docker support for reproducible builds
• tsup for bundling TypeScript code with esbuild
• Import aliases for simplified imports (by default @/ is aliased to ./src/)
• Vitest for testing
• GitHub Actions workflow for linting and testing all pull requests

🌱 Inspired By

• Nest.js default project structure
• Starting a TypeScript Project in 2021 by Chris Hager

📦 Getting Started

1. Clone the repository:

git clone https://github.com/iipanda/node-typescript-boilerplate.git

2. Install pnpm if you haven't already. This project assumes pnpm and won't allow you to install dependencies with other package managers.

3. Install dependencies:

cd node-typescript-boilerplate
pnpm install

🛠 Scripts

• build: Runs tsup to compile and bundle the TypeScript code
• start: Runs the compiled code
• format: Formats the code with Prettier
• lint: Runs ESLint
• lint:fix: Runs ESLint with the --fix flag to attempt to fix the issues automatically
• test: Runs the test suite

📄 License

This project is licensed under the MIT License.

node-typescript-boilerplate's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

dockerfile

Dockerfile

• node 20-slim

github-actions

.github/workflows/check.yml

• actions/checkout v4
• pnpm/action-setup v4
• actions/setup-node v4

npm

package.json

• @eslint/js 9.7.0
• @types/node 20.14.11
• eslint 9.7.0
• prettier 3.3.3
• tsup 8.2.0
• typescript 5.5.3
• typescript-eslint 8.0.0-alpha.46
• vite-tsconfig-paths 4.3.2
• vitest 2.0.3

---

• Check this box to trigger a request for Renovate to run again on this repository