/expressts-restapi-template

Primary LanguageTypeScript

Express TypeScript REST API Template

This template serves as a foundation for building scalable and maintainable RESTful APIs using Express.js and TypeScript. Emphasizing best practices and a modular structure, the project offers a robust architecture that prioritizes flexibility and ease of development.

Getting Started

Prerequisites

  • Node.js (v20.10.0 or later)
  • npm (v10.2.3 or later)

Installation

  1. Clone the repository:

    git clone https://github.com/rahultrivedi180/expressts-restapi-template.git

  2. Install dependencies:

    npm install

Scripts

  • Build the TypeScript files:

    npm run build

  • Run the server:

    npm start

  • Run the server with nodemon for hot reload for development:

    npm run dev

  • Run integration tests:

    npm run integration-test