Skip to content

README.md

Latest commit

 

History

History
74 lines (55 loc) · 1.32 KB

README.md

File metadata and controls

74 lines (55 loc) · 1.32 KB

Express.js with TypeScript

A modern Express.js template built with TypeScript for scalable Node.js applications.

Features

  • 🚀 Express.js framework
  • 📘 TypeScript for type safety
  • 🔥 Hot reload in development
  • 📦 Production-ready build system
  • 🛠️ Development tools configured

Prerequisites

  • Node.js (version 18 or higher)
  • npm or yarn

Installation

Clone this repository and install dependencies:

git clone <your-repo-url>
cd <project-name>
npm install

Available Scripts

Development

npm run dev

Start the development server with hot reload enabled.

Build

npm run build

Compile TypeScript to JavaScript for production.

Watch Mode

npm run watch

Watch for file changes and automatically recompile.

Production

npm run start

Start the production server (requires build first).

Getting Started

  1. Install dependencies: npm install
  2. Start development server: npm run dev
  3. Open your browser at http://localhost:3000

Scripts Workflow

For development:

npm run dev    # Start with hot reload

For production:

npm run build  # Compile TypeScript
npm run start  # Start production server

Note: This template is based on community best practices and has been customized for this project.