Skip to content

gianlucazicca/express-ts-boilerplate

Repository files navigation

Express TypeScript API Boilerplate

This is a boilerplate project for building Express APIs using TypeScript. It includes logging middleware with Morgan and Winston.

Installation

Clone the repository and install dependencies:

git clone https://github.com/yourusername/express-ts-api-boilerplate.git
cd express-ts-api-boilerplate
npm install

Usage

Building

To build the project:

npm run build

Starting

To start the server:

npm start

Development

For development with hot-reloading:

npm run dev

Testing

To run tests:

npm test

Dependencies

  • express: "^4.18.2"
  • body-parser: "^1.20.2"
  • cookie-parser: "^1.4.6"
  • cors: "^2.8.5"
  • dotenv: "^16.3.1"
  • morgan: "^1.10.0"
  • nodemon: "^3.0.1"
  • winston: "^3.9.0"

Development Dependencies

  • @typescript-eslint/eslint-plugin: "^5.59.11"
  • @typescript-eslint/parser: "^5.59.11"
  • eslint: "^8.43.0"
  • jest: "^29.5.0"
  • prettier: "^2.8.8"
  • ts-jest: "^29.1.0"
  • ts-node: "^10.9.1"
  • typescript: "^5.1.3"
  • @types/morgan: "^1.9.4"
  • @types/cookie-parser: "^1.4.3"
  • @types/cors: "^2.8.13"
  • @types/express: "^4.17.17"
  • @types/node: "^20.3.1"

License

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

Author

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published