Repository files navigation

This repository serves as a template for setting up a Node.js project with TypeScript. It includes configuration files fortsconfig.json,package.json, andnodemon.json to help users get started quickly.

Make sure you haveNode.js andnpm installed on your machine.

1. Clone the repository:

   git clone https://github.com/your-username/nodejs-typescript-template.git

2. Navigate to the project directory:

   cd nodejs-typescript-template

3. Install dependencies:

   npm install

To run the project in development mode with automatic code reloading, use:

npm run dev

This command usesnodemon to watch for changes in thesrc/ directory and restarts the server accordingly.

To build the TypeScript source code, use:

npm run build

This command compiles TypeScript files from thesrc/ directory to thedist/ directory.

To run the built application in production, use:

npm run prod

This command executes the compiledindex.js file from thedist/ directory.

• src/: Contains the source code of the application.

  • index.ts: Main entry point of the application.
  • helloWorld.ts: Example module demonstrating TypeScript functionality.

• dist/: Output directory where the compiled JavaScript files are stored.

• tsconfig.json: TypeScript compiler configuration.
• package.json: Project metadata and script definitions.
• nodemon.json: Nodemon configuration for development.