Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 953 Bytes

README.md

File metadata and controls

57 lines (36 loc) · 953 Bytes

NodeJS TypeScript Boilerplate

This project is a boilerplate for creating applications using Node.js and TypeScript.

Features

  • Node.js
  • TypeScript
  • ESLint for linting
  • Jest for testing
  • Husky for Git hooks

Requirements

Make sure you have the following software installed on your machine:

  • Node.js 16.x or later
  • NPM 6.x or later

Getting Started

Follow these steps to get started with the boilerplate:

  1. Clone the repository:

    git clone https://github.com/tomascatena/node-typescript-boilerplate.git

  2. Install the dependencies:

    npm install

  3. Compile TypeScript to JavaScript:

    npm run build

  4. Start the application in development mode:

    npm run dev

  5. Start the application in production mode:

    npm start

License

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