TypeScript Node.js Project

A simple Node.js project setup with TypeScript configuration.

Features

• ✅ TypeScript support with proper configuration
• ✅ Node.js type definitions included
• ✅ Source maps and declarations generated
• ✅ Development and production scripts
• ✅ Clean project structure

Project Structure

├── src/           # TypeScript source files
│   └── index.ts   # Main entry point
├── dist/          # Compiled JavaScript output
├── .github/       # GitHub specific files
├── package.json   # Node.js dependencies and scripts
├── tsconfig.json  # TypeScript configuration
└── .gitignore     # Git ignore patterns

Getting Started

Prerequisites

• Node.js (v18 or higher)
• npm or yarn

Installation

npm install

Development

# Run in development mode (uses ts-node)
npm run dev

# Build the project
npm run build

# Run the compiled JavaScript
npm start

# Watch mode for development
npm run watch

# Clean build artifacts
npm run clean

Scripts

• npm run build - Compile TypeScript to JavaScript
• npm run start - Run the compiled application
• npm run dev - Run directly with ts-node (development)
• npm run watch - Compile in watch mode
• npm run clean - Remove build artifacts

Configuration

TypeScript Configuration

The project uses the following TypeScript configuration:

• Target: ES2020
• Module: CommonJS
• Strict mode: Enabled
• Source maps: Enabled
• Declaration files: Generated

Output

Compiled JavaScript files are output to the dist/ directory with:

• Source maps (.js.map)
• Type declarations (.d.ts)
• Declaration maps (.d.ts.map)

Development Tips

1. Use npm run dev for rapid development with auto-recompilation
2. Use npm run watch to automatically recompile on file changes
3. The project includes Node.js type definitions for full IDE support
4. All TypeScript strict checks are enabled for better code quality

License

ISC