negative333/nodejs-typescript-boilerplate

TypeScript with Node.js Starter

This is a simple starter project to help you get up and running with TypeScript and Node.js for building server-side applications.

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Make sure you have Node.js and npm installed on your machine.

Installing

1. Clone the repository to your local machine:

git clone https://github.com/NegativE333/nodejs-typescript-boilerplate.git

2. Navigate to the project directory:

cd nodejs-typescript-boilerplate

3. Install dependencies:

npm install

Running the Application

To run the application in development mode with automatic TypeScript compilation and server restart:

npm run dev

This command starts the server on port 8000 and watches for changes in your TypeScript files.

To run the application in production mode:

npm start

This command compiles your TypeScript files and starts the server.

Project Structure

• src/: Contains your TypeScript source files.
• build/: Contains compiled JavaScript files.
• tsconfig.json: TypeScript configuration file.
• package.json: Project metadata and npm scripts.

Built With

• TypeScript - Typed superset of JavaScript.
• Express - Web framework for Node.js.