Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 3.65 KB

README.md

File metadata and controls

81 lines (59 loc) · 3.65 KB

node-module-typescript-template

TypeScript version Node.js version APLv2

👩🏻‍💻 Developer Ready: This is a base template that will allow you to focus on developing your new module without worrying about CI/CD implementations, code review, semantic versioning, and other related tasks for Node.js projects.

🏃🏽 Instant Value: All basic tools included and configured:

  • TypeScript 5.1
  • ESM
  • ESLint with some initial rules recommendation
  • Jest for fast unit testing and code coverage
  • Type definitions for Node.js and Jest
  • Prettier to enforce consistent code style
  • EditorConfig for consistent coding style
  • Example configuration for GitHub Actions
  • Simple example of TypeScript code and unit test

🤲 Free as in speech: available under the APLv2 license.

Getting Started

This project is intended to be used with the latest Active LTS release of Node.js.

Use as a repository template

To start, just click the Use template link (or the green button). Start adding your code in the src and unit tests in the test directories.

Clone repository

To clone the repository, use the following commands:

git clone https://github.com/developerplace/node-module-typescript-template

cd node-module-typescript-template

npm install

Additional Information

ES Modules

This template uses native ESM. Make sure to read this, and this first.

If your project requires CommonJS, you will have to convert to ESM.

Please do not open issues for questions regarding CommonJS or ESM on this repo.

License

Licensed under the APLv2. See the LICENSE file for details.