Skip to content

gitblast/node-typescript-skeleton

Repository files navigation

node-typescript-skeleton

A modern TypeScript Node.js starter template with best practices and modern tooling.

Features

  • Fast Development: Uses tsx for lightning-fast TypeScript execution
  • 🎯 TypeScript 5.x: Latest TypeScript with modern ES2022 target
  • 🔍 ESLint: Code linting with TypeScript-specific rules
  • 💅 Prettier: Automatic code formatting
  • 📦 Modern Node.js: Requires Node.js 18+ with ES modules support

Quick Start

# Install dependencies
npm install

# Start development server with hot reload
npm run dev

# Build for production
npm run build

# Run production build
npm start

Available Scripts

  • npm run dev - Start development server with hot reload using tsx
  • npm run build - Build TypeScript to JavaScript
  • npm start - Run the built application
  • npm run clean - Remove build artifacts
  • npm run lint - Run ESLint
  • npm run lint:fix - Run ESLint and fix auto-fixable issues
  • npm run format - Format code with Prettier
  • npm run format:check - Check if code is formatted correctly
  • npm run type-check - Run TypeScript type checking without emitting

Node.js Version

This project requires Node.js 18 or higher. If you use nvm, run:

nvm use

Development

The project is configured with:

  • TypeScript 5.x with strict mode and modern ES2022 target
  • ESLint with TypeScript and Prettier integration
  • Prettier for consistent code formatting
  • tsx for fast TypeScript execution in development

Project Structure

src/
  index.ts          # Main application entry point
dist/               # Built JavaScript files (generated)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors