anjana784 / express-ts

Express.js + TypeScript Boilerplate

This is a simple boilerplate codebase for building web applications using Express.js and TypeScript.

Table of Contents

• Prerequisites
• Installation
• Usage
• Scripts
• Dependencies
• Dev Dependencies
• License
• Author

Prerequisites

Make sure you have the following installed on your machine:

• Node.js
• npm (Node Package Manager)

Installation

1. Clone the repository:

   git clone https://github.com/your-username/express-ts.git

2. Install dependencies:

   cd express-ts
   npm install

Usage

• For development:

  npm run dev

• For building the project:

  npm run build

• For starting the server:

  npm start

• For running tests:

  npm test

Scripts

• dev: Run the application in development mode using ts-node-dev.
• build: Build the TypeScript code into the dist directory.
• start: Start the server using the compiled code in dist.
• test: Run tests using Jest.

Dependencies

• cors: Cross-Origin Resource Sharing middleware.
• dotenv: Loads environment variables from a .env file.
• express: Web framework for Node.js.
• mongoose: MongoDB object modeling tool.
• tsconfig-paths: Extend Node.js module resolution to support TypeScript.

Dev Dependencies

• @types/cors: TypeScript type definitions for cors.
• @types/express: TypeScript type definitions for express.
• ts-node-dev: TypeScript execution environment for development.
• typescript: TypeScript language compiler.

License

This project is licensed under the ISC License - see the LICENSE file for details.

Author

• anjana784